> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neo.projectdiscovery.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Index content into knowledge base

> Upload and index content (from text or URLs) into your personal knowledge base with hybrid search support



## OpenAPI

````yaml https://neo.api.projectdiscovery.io/api/openapi.json post /api/v1/knowledge/index
openapi: 3.1.0
info:
  contact:
    name: ProjectDiscovery
    url: https://neo.projectdiscovery.io
  description: Neo API Server - Security agent orchestration platform
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  title: Neo API
  version: 1.0.0
servers:
  - description: Production
    url: https://neo.api.projectdiscovery.io
  - description: Local development
    url: http://localhost:8080
security: []
tags:
  - description: Task execution and management
    name: Tasks
  - description: Agent listing and management
    name: Agents
  - description: Public agent directory
    name: Agent Directory
  - description: User file storage management
    name: Files
  - description: User working memory management
    name: Memory
  - description: Scheduled and recurring task management
    name: Schedules
  - description: Knowledge base and semantic search
    name: Knowledge
  - description: Encrypted user credentials and API keys
    name: Secrets
  - description: Neo API key management for programmatic access
    name: API Keys
  - description: User profile and account information
    name: User
  - description: Task and LLM usage tracking
    name: Usage
  - description: Bring Your Own Key provider management
    name: BYOK
  - description: Model discovery and capabilities
    name: Models
  - description: Third-party integrations
    name: Integrations
  - description: Skill knowledge documents for agent prompts
    name: Skills
  - description: Team management and member invitations
    name: Teams
  - description: Prompt library management and discovery
    name: Prompts
  - description: Slack bot integration for workspace installation and OAuth
    name: Slack
  - description: GitHub integration for PR reviews and repository management
    name: GitHub
  - description: Vulnerability issue tracking and management
    name: Issues
  - description: Subscription billing and plans
    name: Billing
  - description: Project management and member assignments
    name: Projects
  - description: SSH key pair generation and management for remote server access
    name: SSH Keys
  - description: Codebase structural analysis and mapping
    name: Codemaps
  - description: AI-generated codebase documentation and security analysis
    name: CodeWiki
  - description: Captured HTTP traffic query and replay
    name: Network Events
paths:
  /api/v1/knowledge/index:
    post:
      tags:
        - Knowledge
      summary: Index content into knowledge base
      description: >-
        Upload and index content (from text or URLs) into your personal
        knowledge base with hybrid search support
      operationId: post-v1-knowledge-index
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KnowledgeIndexRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KnowledgeIndexResponse'
          description: Indexing results
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    KnowledgeIndexRequest:
      properties:
        files:
          items:
            $ref: '#/components/schemas/KnowledgeIndexFile'
          minItems: 1
          type: array
        index_name:
          description: Name to identify this knowledge index (e.g., 'security-docs')
          type: string
        options:
          $ref: '#/components/schemas/KnowledgeIndexOptions'
      required:
        - index_name
        - Files
      type: object
    KnowledgeIndexResponse:
      properties:
        indexed:
          $ref: '#/components/schemas/KnowledgeIndexedInfo'
        message:
          type: string
        success:
          type: boolean
      required:
        - success
        - message
        - indexed
      type: object
    ErrorResponse:
      properties:
        code:
          description: >
            Stable machine-readable error code — branch on this rather than

            matching the human `error`/`message` strings. Domain codes include

            `user_spending_cap_reached`, `project_spending_cap_reached`, and

            `insufficient_neo_credits`; otherwise it mirrors the error kind

            (e.g. `forbidden`, `invalid_request`, `not_exists`,
            `already_exists`).
          example: user_spending_cap_reached
          type: string
        error:
          example: Bad request
          type: string
        error_id:
          description: Correlation id for a specific error instance, when present.
          type: string
        kind:
          description: Coarse error category (e.g. "forbidden request", "invalid request").
          example: forbidden request
          type: string
        message:
          description: |
            Human-readable detail (the kind prefixed to the error). For display,
            not for branching.
          type: string
      required:
        - error
      type: object
    KnowledgeIndexFile:
      properties:
        content:
          description: File content (required if url not provided)
          type: string
        language:
          description: 'Programming language or file type (default: markdown)'
          type: string
        relative_path:
          description: File path within the codebase
          type: string
        url:
          description: URL to fetch content from (required if content not provided)
          type: string
      required:
        - relative_path
      type: object
    KnowledgeIndexOptions:
      properties:
        chunk_overlap:
          default: 300
          description: Overlap between chunks
          maximum: 1000
          minimum: 0
          type: integer
        chunk_size:
          default: 2500
          description: Chunk size in characters
          maximum: 5000
          minimum: 500
          type: integer
        force_reindex:
          default: false
          description: Force reindexing even if already exists
          type: boolean
        splitter:
          default: treesitter
          description: Code splitting strategy
          enum:
            - treesitter
            - langchain
          type: string
      type: object
    KnowledgeIndexedInfo:
      properties:
        index_name:
          type: string
        total_chunks:
          type: integer
        total_files:
          type: integer
      required:
        - index_name
        - total_files
        - total_chunks
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT authentication token
      scheme: bearer
      type: http
    ApiKeyAuth:
      description: Neo API key (neo_sk_* prefix)
      in: header
      name: X-Api-Key
      type: apiKey

````