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

# Upload a file

> Uploads a PDF, DOC, DOCX or TXT file (as large as the agent's remaining storage). The file is split
into chunks and indexed before the response is returned.




## OpenAPI

````yaml /openapi.yaml post /agents/{agentId}/sources/files
openapi: 3.0.3
info:
  title: ReyGrid API
  version: 1.0.3
  description: |
    ReyGrid API

    ## Persistent user conversations

    If you want to build a separate conversation system for each user,
    build a wrapper layer around the ReyGrid API.

    The wrapper should manage the application's own user IDs and map them
    to ReyGrid conversations.

    The wrapper is responsible for:
    - Managing and identifying users.
    - Storing the relationship between the application's userId and
      ReyGrid conversationId.
    - Persisting conversation IDs in the application's own database.
    - Reusing the stored conversationId when the same user continues
      a conversation.
    - Verifying that conversation IDs belong to the expected user before
      using them.

    ReyGrid's userId can also be used as a stable identifier for persistent
    conversations. However, if the application requires its own user and
    conversation management, it should maintain this mapping in its own
    database.
servers:
  - url: https://reygrid.com/api/v1
security: []
paths:
  /agents/{agentId}/sources/files:
    post:
      summary: Upload a file
      description: >
        Uploads a PDF, DOC, DOCX or TXT file (as large as the agent's remaining
        storage). The file is split

        into chunks and indexed before the response is returned.
      operationId: uploadFileSource
      parameters:
        - $ref: '#/components/parameters/AgentId'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '201':
          description: File uploaded and indexed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourceCreatedResponse'
              example:
                success: true
                source:
                  id: 661a6da1-181f-43ac-9516-9847b9dd663b
                  type: file
                  title: handbook.pdf
                  size: 482113
        '400':
          description: >-
            Missing file, unsupported type or content that doesn't match the
            extension
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/PlanLimit'
        '404':
          $ref: '#/components/responses/NotFound'
        '413':
          description: >-
            The file is larger than the agent's remaining storage
            (FILE_TOO_LARGE)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            https://reygrid.com/api/v1/agents/{AgentId}/sources/files \
              -H "Authorization: Bearer $REYGRID_API_KEY" \
              -F "file=@handbook.pdf"
        - lang: python
          label: Python SDK
          source: |-
            from reygrid import ReyGrid

            client = ReyGrid(api_key="YOUR_API_KEY")

            # A path, bytes (with filename=...) or an open binary file
            source = client.upload_file("{AgentId}", "handbook.pdf").source
            print(source.id, source.size)
        - lang: javascript
          label: TypeScript SDK
          source: |-
            import { ReyGrid } from "reygrid";

            const client = new ReyGrid({ apiKey: "YOUR_API_KEY" });

            import { openAsBlob } from "node:fs";

            const { source } = await client.uploadFile(
              "{AgentId}",
              await openAsBlob("handbook.pdf"),
              "handbook.pdf",
            );
            console.log(source.id, source.size);
components:
  parameters:
    AgentId:
      name: agentId
      in: path
      required: true
      description: The ID of the agent.
      schema:
        type: string
  schemas:
    SourceCreatedResponse:
      type: object
      properties:
        success:
          type: boolean
        source:
          type: object
          properties:
            id:
              type: string
            type:
              $ref: '#/components/schemas/SourceType'
            title:
              type: string
            size:
              type: integer
              description: Only for files.
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
        output:
          type: object
          additionalProperties: true
        error:
          $ref: '#/components/schemas/Error'
        usage:
          $ref: '#/components/schemas/ChatUsage'
    SourceType:
      type: string
      enum:
        - text
        - qa
        - file
        - website
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        list:
          type: array
          description: |
            Validation error details.
            Present when error.code is INVALID_BODY.
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
    ChatUsage:
      type: object
      required:
        - credits
      properties:
        credits:
          type: number
    AuthErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          example: Unauthorized
        code:
          type: string
          example: AUTH_REQUIRED
    ValidationErrorItem:
      type: object
      additionalProperties: true
  responses:
    Unauthorized:
      description: API key is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: Unauthorized
            code: AUTH_REQUIRED
    PlanLimit:
      description: The plan's storage or page limit is reached (PLAN_LIMIT_REACHED)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: PLAN_LIMIT_REACHED
              message: You need to upgrade your plan
    NotFound:
      description: The agent, source or message doesn't exist, or the key can't access it
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: SOURCE_NOT_FOUND
              message: This source does not exist
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API-Key
      description: ReyGrid API key sent as a Bearer token.

````

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