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

# Upload a knowledge base

> Uploads a document to the tenant's workspace library, not yet
indexed into any agent's knowledge base. Allowed types: .pdf, .txt,
.md, .html. Attach it to an agent with POST
/api/v1/agents/{agent_id}/documents/associate/{doc_id} to actually
index it: that step is what triggers indexing cost, not this upload.
Every approved type is capped at a uniform 20MB per file.



## OpenAPI

````yaml /openapi.json post /api/v1/documents
openapi: 3.1.0
info:
  title: Eclatira API
  description: >-
    Programmatically create calls and batches, manage agents/tools/knowledge,
    and retrieve conversation analytics.
  contact:
    name: Eclatira Support
    email: contact@eclatira.com
  version: 1.0.0
servers:
  - url: https://app.eclatira.com
    description: API Server
security: []
tags:
  - name: developer-api
    description: >-
      The API-key-authenticated developer surface: calls, batches, and agents.
      Authenticate with `Authorization: Bearer ek_...`.
  - name: Calls
    description: Place outbound calls with an agent, check status, list history.
  - name: Batches
    description: 'Outbound call campaigns: create, list, inspect, cancel, retry.'
  - name: Agents
    description: Create and manage the agents that place and receive calls.
  - name: Tools
    description: Custom actions an agent can call mid-call, attached per-agent.
  - name: MCP Servers
    description: >-
      Connect an agent to an external MCP (Model Context Protocol) server so it
      can call that server's tools, with static or OAuth auth.
  - name: Knowledge Base
    description: Upload files and index them into an agent's knowledge base.
  - name: Realtime
    description: >-
      Mint a short-lived session token to open a live voice/video WebSocket
      connection: the only supported way for an API-key holder to authenticate
      into /ws/{user_id}.
  - name: Webhooks
    description: >-
      Register a durable callback URL to receive call.completed and
      batch.completed events for every matching workspace event, and fetch the
      tenant signing secret used to verify X-Webhook-Signature.
  - name: developer-api-keys
    description: >-
      Account-management routes (create/list/revoke API keys), authenticated via
      dashboard login, not an API key, since they mint the credentials the rest
      of the developer API uses.
paths:
  /api/v1/documents:
    post:
      tags:
        - Knowledge Base
        - developer-api
      summary: Upload a knowledge base
      description: |-
        Uploads a document to the tenant's workspace library, not yet
        indexed into any agent's knowledge base. Allowed types: .pdf, .txt,
        .md, .html. Attach it to an agent with POST
        /api/v1/agents/{agent_id}/documents/associate/{doc_id} to actually
        index it: that step is what triggers indexing cost, not this upload.
        Every approved type is capped at a uniform 20MB per file.
      operationId: uploadDocument
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  title: File
              required:
                - file
              title: Body_uploadDocument
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1DocumentResponse'
        '402':
          description: >-
            The tenant's billing status blocks new document uploads (e.g. a
            past_due/unpaid subscription), or the tenant has reached its plan's
            document-count limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '413':
          description: >-
            The file exceeds the uniform 20MB per-document size cap, checked via
            the Content-Length header before the upload body is read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '422':
          description: 'The file''s type isn''t in the allowed list: .pdf, .txt, .md, .html.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    V1DocumentResponse:
      properties:
        doc_id:
          type: string
          title: Doc Id
        file_name:
          type: string
          title: File Name
        status:
          type: string
          enum:
            - ready
            - processing
            - error
          title: Status
        size_bytes:
          type: integer
          title: Size Bytes
          default: 0
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - doc_id
        - file_name
        - status
      title: V1DocumentResponse
    V1ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/V1ErrorDetail'
      type: object
      required:
        - error
      title: V1ErrorResponse
      description: |-
        The error envelope every `developer-api`-tagged route returns for
        non-2xx responses, including `422`; this overrides FastAPI's default
        validation-error shape.
    V1ErrorDetail:
      properties:
        type:
          type: string
          title: Type
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
        param:
          anyOf:
            - type: string
            - type: 'null'
          title: Param
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
      type: object
      required:
        - type
        - code
        - message
      title: V1ErrorDetail
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        A long-lived, privileged API key (`ek_...` prefix), minted once from the
        dashboard. Intended for trusted server-side use only; never expose it in
        client-side code. Send as `Authorization: Bearer ek_...`. Required by
        every Calls, Batches, Agents, Tools, MCP Servers, Documents, and
        Realtime route.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.