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

# Upload Video

> Upload a video file to a collection for indexing.

Accepted formats: MP4, MOV, AVI, WebM, MPEG, MKV. Processing is asynchronous — use the
returned `job_id` to poll `GET /v1/jobs/{job_id}` for progress. Once the job status
is `done`, the video is fully searchable.



## OpenAPI

````yaml /openapi.json post /v1/upload
openapi: 3.1.0
info:
  title: Pureframe API
  version: v1
  description: >-
    The Pureframe API lets you upload videos, index them for semantic search,
    and retrieve timestamped clips matching text queries or reference images.
    All endpoints require a Bearer API key (`Authorization: Bearer pf_...`).
  contact:
    url: https://pureframe.ai
    email: hello@pureframe.ai
  x-logo:
    url: https://pureframe.ai/logo.png
servers:
  - url: https://api.pureframe.ai
    description: Production
security: []
tags: []
paths:
  /v1/upload:
    post:
      tags:
        - Upload
      summary: Upload Video
      description: >-
        Upload a video file to a collection for indexing.


        Accepted formats: MP4, MOV, AVI, WebM, MPEG, MKV. Processing is
        asynchronous — use the

        returned `job_id` to poll `GET /v1/jobs/{job_id}` for progress. Once the
        job status

        is `done`, the video is fully searchable.
      operationId: upload_video_v1_upload_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_video_v1_upload_post'
        required: true
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_UploadResult_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    Body_upload_video_v1_upload_post:
      properties:
        collection_id:
          type: string
          minLength: 1
          title: Collection Id
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        webhook_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Webhook Url
      type: object
      required:
        - collection_id
        - file
      title: Body_upload_video_v1_upload_post
    ApiResponse_UploadResult_:
      properties:
        data:
          $ref: '#/components/schemas/UploadResult'
        meta:
          $ref: '#/components/schemas/Meta'
      type: object
      required:
        - data
        - meta
      title: ApiResponse[UploadResult]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UploadResult:
      properties:
        job_id:
          type: string
          title: Job Id
        video_id:
          type: string
          title: Video Id
        status:
          type: string
          title: Status
      type: object
      required:
        - job_id
        - video_id
        - status
      title: UploadResult
    Meta:
      properties:
        request_id:
          type: string
          title: Request Id
        took_ms:
          type: number
          title: Took Ms
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
        page:
          anyOf:
            - type: integer
            - type: 'null'
          title: Page
        per_page:
          anyOf:
            - type: integer
            - type: 'null'
          title: Per Page
        facets:
          anyOf:
            - additionalProperties:
                additionalProperties:
                  type: integer
                type: object
              type: object
            - type: 'null'
          title: Facets
      type: object
      required:
        - request_id
        - took_ms
      title: Meta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````