> ## Documentation Index > Fetch the complete documentation index at: https://testweb2-docs-openapi.test765.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Five API is a video generation REST API. Base URL: https://api.fiveapi.ai. Authenticate with the header Authorization: Bearer ; read the key from the FIVEAPI_API_KEY environment variable and never hard-code it. > Every generation is an asynchronous task: POST /v1/{brand}/{version}/{task} returns a queued task, then poll GET /v1/tasks/{task_id} or receive a signed webhook, and download output.video.url before expires_at (7 days). > The OpenAPI spec is at https://docs.fiveapi.ai/api-reference/openapi.yaml. An installable agent skill: npx skills add https://docs.fiveapi.ai # List models > Lists the enabled models in catalogue order. Each model carries `input_schema`, the JSON Schema of its request body, which is the authoritative list of fields and allowed values. **Scope:** any valid key. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/models openapi: 3.1.0 info: title: Five API version: 1.0.0 summary: Generate AI videos from text, images, reference assets and clips. description: > The Five API turns a text prompt, an image, a set of reference assets or a video clip into a short video. Every generation is an asynchronous **task**: `POST /v1/{brand}/{version}/{task}` returns a `queued` task at once, and the result arrives by webhook or by polling `GET /v1/tasks/{task_id}`. * Base URL: `https://api.fiveapi.ai` * Authentication: `Authorization: Bearer ` (or the `x-api-key` header) * JSON in and out, `snake_case` fields, UTF-8, ISO 8601 UTC timestamps * Every response carries `X-Request-Id`; error bodies repeat it as `error.request_id` contact: name: Five API support email: support@fiveapi.ai url: https://docs.fiveapi.ai servers: - url: https://api.fiveapi.ai description: Production security: - bearerAuth: [] tags: - name: Video Fast 1.0 description: Fast, low-cost generation at 480p or 768p. - name: Wan 3.0 Spark description: Native 30-second video with richer detail and synchronized audio. - name: Wan 3.0 Prime Spark description: Wan 3.0 quality at full 30 seconds, noticeably faster. - name: Video Fast Extend 1.1 description: Continue an existing clip with matched audio. - name: Tasks description: Read, list and cancel generation tasks. - name: Models description: The model catalogue and each model's input schema. - name: Account description: Balance, plan limits and daily usage. paths: /v1/models: get: tags: - Models summary: List models description: > Lists the enabled models in catalogue order. Each model carries `input_schema`, the JSON Schema of its request body, which is the authoritative list of fields and allowed values. **Scope:** any valid key. operationId: listModels responses: '200': description: The enabled models. headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/ModelList' examples: models: $ref: '#/components/examples/ModelListExample' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' components: headers: X-Request-Id: description: Id of this request (`req_...`). Quote it when you contact support. schema: type: string examples: - req_01M5KPY92Y148QP01G532MM3BH Retry-After: description: Seconds to wait before retrying. schema: type: integer examples: - 10 X-RateLimit-Limit: description: >- Requests per minute allowed for your account (or the key's lower ceiling). schema: type: integer examples: - 300 X-RateLimit-Remaining: description: Requests left in the current minute. schema: type: integer examples: - 287 X-RateLimit-Reset: description: Unix time in seconds when the minute window resets. schema: type: integer format: int64 examples: - 1792736640 schemas: ModelList: type: object required: - object - data - has_more properties: object: type: string const: list data: type: array items: $ref: '#/components/schemas/Model' has_more: type: boolean Model: type: object required: - id - object - name - task - status - input_schema properties: id: type: string description: '`{brand}/{version}/{task}`, also the path of its create endpoint.' examples: - wan/v3.0-spark/image-to-video object: type: string const: model name: type: string examples: - Wan 3.0 Spark — image to video task: type: string enum: - text-to-video - image-to-video - reference-to-video - video-extend status: type: string enum: - enabled - disabled input_schema: type: object additionalProperties: true description: >- JSON Schema of the request body. `x-max-input-bytes` gives the largest accepted input file. pricing: type: - object - 'null' additionalProperties: true description: >- Reserved for a public price view. Omitted today; prices are listed in the [developer console](https://fiveapi.ai), and every task shows its price as `credits.estimated`. Error: type: object required: - error properties: error: type: object required: - type - code - message - request_id properties: type: type: string enum: - invalid_request_error - authentication_error - billing_error - permission_error - not_found_error - conflict_error - rate_limit_error - api_error description: The error category. code: type: string description: >- Stable machine-readable code. Branch on this, never on `message`. examples: - insufficient_credits message: type: string description: Human-readable detail. It may change. param: type: string description: The request field at fault, when there is one. request_id: type: string description: Same as the `X-Request-Id` header. details: type: object additionalProperties: true description: >- Extra members for some codes, for example `required` and `available` on `insufficient_credits`. examples: ModelListExample: summary: The enabled models (input schemas shortened) value: object: list data: - id: video-fast/v1.0/image-to-video object: model name: Video Fast 1.0 — image to video task: image-to-video status: enabled input_schema: type: object required: - image_url - duration - resolution x-max-input-bytes: 31457280 - id: video-fast/v1.0/text-to-video object: model name: Video Fast 1.0 — text to video task: text-to-video status: enabled input_schema: type: object required: - prompt - duration - resolution - id: video-fast/v1.0/reference-to-video object: model name: Video Fast 1.0 — reference to video task: reference-to-video status: enabled input_schema: type: object required: - prompt - duration - resolution x-max-input-bytes: 31457280 - id: wan/v3.0-spark/image-to-video object: model name: Wan 3.0 Spark — image to video task: image-to-video status: enabled input_schema: type: object required: - image_url - duration - resolution x-max-input-bytes: 20971520 - id: video-fast/v1.1/video-extend object: model name: Video Fast Extend 1.1 — video extend task: video-extend status: enabled input_schema: type: object required: - video_url - prompt - duration - resolution x-max-input-bytes: 524288000 has_more: false responses: Unauthorized: description: >- The API key is missing, unknown, revoked or expired (`invalid_api_key`, `api_key_revoked`, `api_key_expired`). headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/Error' examples: invalid_api_key: summary: No key, or an unknown key value: error: type: authentication_error code: invalid_api_key message: >- missing API key: send Authorization: Bearer sk_live_… (or x-api-key) request_id: req_01M5KN14MXD6SJ01ZQ2FPS6Y8X api_key_revoked: summary: The key was revoked in the console value: error: type: authentication_error code: api_key_revoked message: this API key has been revoked request_id: req_01M5KN14PY5YH5QPA2QS7Y07Y4 TooManyRequests: description: > A limit of your plan was reached: the request rate (`rate_limit_exceeded`), the number of queued and processing tasks (`concurrency_limit_exceeded`) or the daily credit cap (`daily_cap_exceeded`). Wait `Retry-After` seconds before retrying. headers: Retry-After: $ref: '#/components/headers/Retry-After' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/Error' examples: rate_limit_exceeded: summary: Too many requests value: error: type: rate_limit_error code: rate_limit_exceeded message: rate limit exceeded for this account (10 rps, 300 rpm) request_id: req_01M5KN37C3D4E5F6G7H8J9K0L1 concurrency_limit_exceeded: summary: Too many tasks in flight value: error: type: rate_limit_error code: concurrency_limit_exceeded message: >- the account already has 20 tasks queued or processing (plan limit 20) request_id: req_01M5KN37D4E5F6G7H8J9K0L1M2 daily_cap_exceeded: summary: Daily credit cap reached value: error: type: rate_limit_error code: daily_cap_exceeded message: this account's daily credit cap (5000) would be exceeded request_id: req_01M5KN37E5F6G7H8J9K0L1M2N3 securitySchemes: bearerAuth: type: http scheme: bearer description: > Your API key from the [developer console](https://fiveapi.ai), sent as `Authorization: Bearer sk_live_...`. The `x-api-key: sk_live_...` header is accepted as an alternative. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.