VidPlate Uploads API

openapi: 3.2.0
info:
  title: VidPlate Uploads API
  version: v1
  summary: Render video and images from your own templates, on your own machines.
  description: 'Server-to-server only: send your secret key as "Authorization: Bearer vpk_live_...". Requests from a browser are refused, and a secret key must never be put in a web page or an app.


    Every response carries X-Request-Id. Errors use one shape (see the Error schema) with stable codes. Lists use cursor pagination: pass next_cursor as starting_after.


    Rate limits are per key and per workspace, with RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset headers, and Retry-After on 429.


    Renders run on your workspace''s own Browser Nodes (the render-nodes endpoints) and are not charged per render; paid API plans have a daily render limit and a monthly video-minutes allowance (429 quota_exceeded and 429 video_minutes_exceeded); Studio Pro has 10,000 static outputs and 2,000 video minutes a calendar month (429 static_outputs_exceeded and 429 video_minutes_exceeded) plus a daily safety limit (429 quota_exceeded); the Sandbox has one-off totals for its whole trial (402 sandbox_allowance_used). Webhooks are signed (VidPlate-Signature: t=..., v1=HMAC-SHA256 of "t.body") and carry IDs and statuses only.'
servers:
- url: https://api.vidplate.app/v1
  description: VidPlate API
- url: https://vidplate.app/api/v1
  description: Legacy base URL. It keeps working for existing integrations.
security:
- apiKey: []
tags:
- name: Uploads
  description: Images and 3D models to use as field values.
paths:
  /uploads:
    post:
      operationId: createUpload
      tags:
      - Uploads
      summary: Create an upload
      description: Returns an upload ID and a signed PUT URL (valid 1 hour). PUT the file to it with exactly the headers returned, then call complete. Images up to 50 MB and 16.7 megapixels (PNG, JPEG, WebP); 3D models (GLB) up to 100 MB. Video uploads open with video renders.
      security:
      - apiKey: []
      x-required-scopes:
      - uploads:write
      parameters:
      - name: Idempotency-Key
        in: header
        required: true
        description: Any unique string (1 to 255 visible characters). Sending the same key with the same body returns the first response; with a different body, 409 idempotency_key_reused. Kept 24 hours.
        schema:
          type: string
          maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
              - filename
              - content_type
              - size_bytes
              properties:
                filename:
                  type: string
                  minLength: 1
                  maxLength: 200
                content_type:
                  enum:
                  - image/png
                  - image/jpeg
                  - image/webp
                  - model/gltf-binary
                  - video/mp4
                  - video/quicktime
                  - video/webm
                  - audio/mpeg
                  - audio/mp4
                  - audio/x-m4a
                  - audio/aac
                  - audio/wav
                  - audio/x-wav
                  - audio/ogg
                size_bytes:
                  type: integer
                  minimum: 1
                purpose:
                  enum:
                  - render_input
            example:
              filename: product-48213.png
              content_type: image/png
              size_bytes: 482110
      responses:
        '201':
          description: The upload, with the signed PUT.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Upload'
              example:
                object: upload
                id: upl_6729c0a1b2c3d4e5f6a7b8e1
                status: pending
                filename: product-48213.png
                content_type: image/png
                kind: image
                size_bytes: 482110
                width: null
                height: null
                rejected_reason: null
                upload:
                  method: PUT
                  url: https://<bucket>.s3.eu-west-2.amazonaws.com/api-uploads/...?X-Amz-...
                  headers:
                    Content-Type: image/png
                    Content-Length: '482110'
                  expires_at: '2026-11-02T10:15:00.000Z'
                expires_at: '2026-11-09T09:15:00.000Z'
                created_at: '2026-11-02T09:15:00.000Z'
                completed_at: null
        '400':
          description: 'Error. Codes: file_too_large, unsupported_content_type.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: invalid_request
                  code: file_too_large
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '422':
          description: 'Error. Codes: storage_limit_reached, video_uploads_not_available.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: unprocessable
                  code: storage_limit_reached
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
  /uploads/{upload_id}/complete:
    post:
      operationId: completeUpload
      tags:
      - Uploads
      summary: Verify an uploaded file
      description: Checks the size and content type, and reads the file to confirm its real format (and an image's dimensions). status becomes ready, or rejected with rejected_reason (the file is then deleted). Calling it again returns the same result.
      security:
      - apiKey: []
      x-required-scopes:
      - uploads:write
      parameters:
      - name: upload_id
        in: path
        required: true
        description: Upload ID.
        schema:
          type: string
          pattern: ^upl_
        example: upl_6729c0a1b2c3d4e5f6a7b8e1
      - name: Idempotency-Key
        in: header
        required: false
        description: Any unique string (1 to 255 visible characters). Sending the same key with the same body returns the first response; with a different body, 409 idempotency_key_reused. Kept 24 hours.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: The upload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Upload'
              example:
                object: upload
                id: upl_6729c0a1b2c3d4e5f6a7b8e1
                status: ready
                filename: product-48213.png
                content_type: image/png
                kind: image
                size_bytes: 482110
                width: 2000
                height: 2500
                rejected_reason: null
                expires_at: '2026-11-09T09:15:00.000Z'
                created_at: '2026-11-02T09:15:00.000Z'
                completed_at: '2026-11-02T09:16:00.000Z'
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '404':
          description: 'Error. Codes: upload_not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: not_found
                  code: upload_not_found
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '409':
          description: 'Error. Codes: upload_incomplete, upload_expired.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: conflict
                  code: upload_incomplete
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
  /uploads/{upload_id}:
    get:
      operationId: getUpload
      tags:
      - Uploads
      summary: Get an upload
      security:
      - apiKey: []
      x-required-scopes:
      - uploads:write
      parameters:
      - name: upload_id
        in: path
        required: true
        description: Upload ID.
        schema:
          type: string
          pattern: ^upl_
        example: upl_6729c0a1b2c3d4e5f6a7b8e1
      responses:
        '200':
          description: The upload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Upload'
        '401':
          description: 'Error. Codes: invalid_api_key.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: authentication_failed
                  code: invalid_api_key
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '403':
          description: 'Error. Codes: missing_scope, plan_not_eligible.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: permission_denied
                  code: missing_scope
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '404':
          description: 'Error. Codes: upload_not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: not_found
                  code: upload_not_found
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '429':
          description: 'Error. Codes: too_many_requests.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: rate_limited
                  code: too_many_requests
                  message: '...'
                  request_id: req_0123456789abcdef01234567
        '500':
          description: 'Error. Codes: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  type: api_error
                  code: internal_error
                  message: '...'
                  request_id: req_0123456789abcdef01234567
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - type
          - code
          - message
          - request_id
          properties:
            type:
              enum:
              - invalid_request
              - payment_required
              - authentication_failed
              - permission_denied
              - not_found
              - conflict
              - unprocessable
              - rate_limited
              - api_error
              - service_unavailable
            code:
              type: string
              description: Stable, documented code.
            message:
              type: string
            param:
              type: string
              description: The request field the error is about, when there is one.
            errors:
              type: array
              description: Every problem found (schema_validation_failed).
              items:
                type: object
                properties:
                  param:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
            request_id:
              type: string
              description: Quote this when asking for help.
    Upload:
      type: object
      properties:
        object:
          const: upload
        id:
          type: string
        status:
          enum:
          - pending
          - ready
          - rejected
          - expired
        filename:
          type: string
        content_type:
          type: string
        kind:
          enum:
          - image
          - video
          - model3d
          - audio
        size_bytes:
          type: integer
        width:
          type:
          - integer
          - 'null'
        height:
          type:
          - integer
          - 'null'
        rejected_reason:
          type:
          - string
          - 'null'
        upload:
          type: object
          description: Only when the upload is created.
          properties:
            method:
              const: PUT
            url:
              type: string
            headers:
              type: object
              additionalProperties:
                type: string
            expires_at:
              type: string
        expires_at:
          type:
          - string
          - 'null'
        created_at:
          type:
          - string
          - 'null'
        completed_at:
          type:
          - string
          - 'null'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: vpk_live_...
      description: 'Workspace keys, created by workspace admins in VidPlate under Admin, then API. Scopes: templates:read (List templates, versions and their input schemas.); uploads:write (Upload images and video to use in renders.); renders:write (Create, cancel and retry renders.); renders:read (Check render status and download outputs.); webhooks:manage (Register and change webhook endpoints.); assets:read (Use Asset Library files as render inputs.); ai:spend (Allow renders that use AI voiceover or AI Recipes. These spend your AI credits.); render_nodes:read (See whether your render nodes are online, busy or offline, and what they can render.); storage_destinations:manage (Add, change, test and delete your own buckets that outputs are delivered to (Growth and above).)'