Skip to article
Documentation

Search documentation

Search stays in this browser. Queries are not sent or saved. Do not paste credentials.

Loading the public search index…

Tab or arrow keys to navigate · Enter to open · Esc to close
Browse documentation

Prepare video upload

Source-generated POST /video-uploads reference: authentication, fields, responses, errors, and operational safeguards.

Public betaAPI v1 · 1.5.0Last verified
On this page

Operation

POST /video-uploads

operationId: create_video_upload_v1_video_uploads_post

Create a private video upload session (MP4/MOV/WebM, at most 100 MiB, 2–30 seconds). PUT exact bytes with the returned URL and headers, then complete the session. Reuses account storage quota; starts no inference or generation.

Authentication and side effects

Use a server-side Bearer API key. Required scope: animations:write

This operation does not start paid generation. Other state changes are described above.

Parameters

No path, query, or operation-specific header parameters.

Request body (application/json)

Body required: true

Field Type Required Default Constraints Meaning
byte_size integer Yes — maximum: 104857600; exclusiveMinimum: 0 Exact byte count, at most 100 MiB. The source must be 2–30 seconds.
filename string Yes — minLength: 1; maxLength: 240 Client filename, not a readable server path.
mime_type string Yes — enum: "video/mp4", "video/quicktime", "video/webm" Actual MP4, MOV or WebM media type.

Full nested schema: VideoUploadRequest

Responses

HTTP Body Meaning
201 VideoUploadSession Successful public response. Example values are illustrative.
400 APIErrorEnvelope Invalid input; correct the request before retrying.
401 APIErrorEnvelope Missing, expired, or revoked API key.
403 APIErrorEnvelope Account eligibility, account status, or key scope does not allow this operation.
404 APIErrorEnvelope Resource is unavailable, not owned, or its signature is invalid/expired.
409 APIErrorEnvelope Idempotency conflict; only IDEMPOTENCY_IN_PROGRESS is retryable with the original request.
410 APIErrorEnvelope Upload session expired; prepare a new upload.
413 APIErrorEnvelope Request or decoded image exceeds the configured limit.
415 APIErrorEnvelope Use supported image media types.
422 APIErrorEnvelope Video metadata or size is invalid.
429 APIErrorEnvelope Account-wide rate or queue limit; wait for Retry-After.
500 APIErrorEnvelope Internal failure; preserve the task/key and retry only when marked retryable.
503 APIErrorEnvelope Service/provider unavailable; retry only when error.retryable is true.

Response headers

HTTP Header Type Meaning
429 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.
503 Retry-After integer Suggested wait in seconds; respect the server value and an overall deadline.

Response example

json
{
  "expires_at": "2026-08-30T00:00:00Z",
  "headers": {
    "Content-Type": "video/mp4",
    "X-AnimGen-Upload-Token": "illustrative-only"
  },
  "max_bytes": 104857600,
  "method": "PUT",
  "upload_id": "00000000-0000-4000-8000-000000000001",
  "upload_url": "https://uploads.example.invalid/illustrative-video"
}

Polling and downloads · Errors and safe retries

Was this page helpful?

No search queries, code, or free text are collected. This switch controls documentation interactions only; general site analytics follow the privacy policy. Privacy policy

Need a hand? Contact support