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

# List upload purposes

> The accepted `purpose` values with their limits, so clients can validate before uploading.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/files/purposes
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
security:
  - bearerAuth: []
paths:
  /v1/files/purposes:
    get:
      tags:
        - Files
      summary: List upload purposes
      description: >-
        The accepted `purpose` values with their limits, so clients can validate
        before uploading.
      responses:
        '200':
          description: All purposes.
          content:
            application/json:
              schema:
                type: object
                properties:
                  purposes:
                    type: array
                    items:
                      $ref: '#/components/schemas/FilePurpose'
                required:
                  - purposes
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    FilePurpose:
      type: object
      properties:
        name:
          type: string
          example: dispute.evidence
        maxSizeBytes:
          type: integer
          example: 10485760
        allowedTypes:
          type: array
          items:
            type: string
          example:
            - image/jpeg
            - image/png
            - image/webp
            - application/pdf
      required:
        - name
        - maxSizeBytes
        - allowedTypes
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````