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

# Add a document

> Add content to a knowledge base from a file upload or a URL.

<Note>
  Send **either** a `file` or a `source_url`, not both. The response is `202` - ingestion runs in the
  background. Poll [Get a knowledge base](/developers/knowledge-bases/get) until the document's
  `status` reads `processed`; a `failed` document carries an `error_message`.
</Note>


## OpenAPI

````yaml developers/openapi.json POST /v1/knowledge-bases/{kb_id}/documents
openapi: 3.1.0
info:
  title: Vocily API
  description: >-
    Public REST API for Vocily. Build and configure an agent, publish a version
    and put it live, place outbound calls, and read back calls, chats and what
    the agent remembered. Authenticate with a workspace API key as a Bearer
    token.


    Some things stay in the dashboard, by design: creating an API key, buying or
    connecting a phone number, setting an agent's webhook URL, connecting
    WhatsApp and its templates, building HTTP tools, and running batch
    campaigns.
  version: v1
servers:
  - url: https://api.vocily.ai
    description: Production
security: []
paths:
  /v1/knowledge-bases/{kb_id}/documents:
    post:
      tags:
        - knowledge-bases
      summary: Add Document
      description: >-
        Add content to a knowledge base.


        Returns `202` immediately — **ingestion is asynchronous**. Poll `GET
        /v1/knowledge-bases/{id}`

        until the document's `status` reports success; it is not searchable
        before then.
      operationId: add_document_v1_knowledge_bases__kb_id__documents_post
      parameters:
        - name: kb_id
          in: path
          required: true
          schema:
            type: string
            title: Kb Id
          description: The knowledge base's id, from `POST`/`GET /v1/knowledge-bases`.
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/Body_add_document_v1_knowledge_bases__kb_id__documents_post
      responses:
        '202':
          description: >-
            Accepted — the document is queued for processing. Poll the knowledge
            base until its `status` reads `processed`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicKnowledgeBaseDocumentRead'
              example:
                id: 00000001-0000-4000-8000-000000000001
                file_name: refund-policy-2026.pdf
                source_url: null
                mime_type: application/pdf
                status: processing
                error_message: null
                created_at: '2026-09-17T09:14:02Z'
                updated_at: '2026-09-17T09:14:02Z'
        '400':
          description: Provide either a file or a `source_url` — not both, and not neither.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                detail: >-
                  Provide either a file or a `source_url` — not both, and not
                  neither.
                code: BAD_REQUEST
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                detail: Invalid API key
                code: UNAUTHORIZED
        '404':
          description: Knowledge base not found in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                detail: Knowledge base not found in this workspace.
                code: NOT_FOUND
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded — honor `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                code: rate_limited
      security:
        - bearerAuth: []
components:
  schemas:
    Body_add_document_v1_knowledge_bases__kb_id__documents_post:
      properties:
        source_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Url
          description: >-
            Fetch the document from this URL instead of uploading bytes. Send
            this OR `file`, never both and never neither.
        file:
          anyOf:
            - type: string
              contentMediaType: application/octet-stream
            - type: 'null'
          title: File
          description: >-
            The document itself. Send this OR `source_url`. Read back as
            `file_name` — the response names what we stored, not the bytes.
      type: object
      title: Body_add_document_v1_knowledge_bases__kb_id__documents_post
    PublicKnowledgeBaseDocumentRead:
      description: >-
        One piece of content in a knowledge base, as the public API promises it.


        `status` is the ingestion state — adding a document returns 202 and
        processing happens in the

        background, so a client polls the KB until this reads `processed`.
      properties:
        id:
          description: The document's id.
          title: Id
          type: string
        file_name:
          anyOf:
            - type: string
            - type: 'null'
          description: The name we stored it under.
          title: File Name
        source_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Where it was fetched from, for a URL-sourced document.
          title: Source Url
        mime_type:
          anyOf:
            - type: string
            - type: 'null'
          description: What kind of file it is.
          title: Mime Type
        status:
          description: >-
            Where ingestion got to — `pending`, `processing`, `processed`, or
            `failed`. **Ingestion is asynchronous**: the upload returns `202`
            and the document is not searchable until this reads `processed`. On
            `failed`, `error_message` says why.
          title: Status
          type: string
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          description: Why ingestion failed, if it did.
          title: Error Message
        created_at:
          description: When it was uploaded (UTC, ISO 8601).
          format: date-time
          title: Created At
          type: string
        updated_at:
          description: When its status last changed (UTC, ISO 8601).
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - file_name
        - source_url
        - mime_type
        - status
        - error_message
        - created_at
        - updated_at
      title: PublicKnowledgeBaseDocumentRead
      type: object
    ApiError:
      type: object
      description: >-
        Error envelope. `code` is derived from the HTTP status, so branch on it
        for the CLASS of failure; the specific reason is `detail.code`. Every
        public refusal carries both.
      properties:
        detail:
          type: object
          description: >-
            The reason. `code` is the domain reason (e.g. `call_not_found`) and
            `message` is a sentence safe to log. On a `422` it also carries
            `errors[]`, one entry per rejected field — see
            `HTTPValidationError`.
          properties:
            code:
              type: string
              example: call_not_found
            message:
              type: string
              example: Call not found
          required:
            - code
            - message
        code:
          type: string
          description: Derived from the HTTP status, not the domain reason.
          example: NOT_FOUND
    HTTPValidationError:
      type: object
      title: HTTPValidationError
      description: >-
        A request the API could not read: a field of the wrong type, out of
        range, missing, or one we do not accept. Same envelope as every other
        error.
      properties:
        detail:
          type: object
          description: >-
            What was wrong, as `code`, a one-line `message`, and every offending
            field in `errors`.
          required:
            - code
            - message
            - errors
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
              description: >-
                The first problem in one line, with a count of the rest — e.g.
                `model.temperature: Input should be less than or equal to 2 (and
                1 more)`.
            errors:
              type: array
              items:
                $ref: '#/components/schemas/ValidationError'
              description: >-
                One entry per offending field. **Every problem is reported at
                once**, not just the first, so a malformed body needs one round
                trip to fix rather than one per field.
        code:
          type: string
          enum:
            - VALIDATION_ERROR
          description: Derived from the HTTP status, as on every error.
    ValidationError:
      type: object
      title: ValidationError
      required:
        - field
        - message
        - type
      properties:
        field:
          type: string
          description: >-
            The offending field as a path from the root of your request —
            `voice.speed`, `variables[0].key`, or `query.limit` for a query
            parameter. **This is the field to read.**
        message:
          type: string
          description: What is wrong with it, in plain language.
        type:
          type: string
          description: >-
            A stable machine code for the kind of failure, e.g.
            `extra_forbidden` for a field we do not accept, `missing` for a
            required one, or `less_than_equal` for a number out of range. Switch
            on this rather than on `message`, which may be reworded.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key as a Bearer token, e.g. `Authorization: Bearer vk_…`.'

````