Base URL, authentication, request and response conventions of the Five API.
The Five API is a REST API. You send JSON over HTTPS and get JSON back. Every endpoint page in this section has an interactive playground: add your API key and send real requests from the browser.
Requests from the playground are real: creating a task holds and charges credits from your balance.
GET /v1/tasks uses cursor paging. Pass limit (1–100, default 20) and, for the next page, starting_after set to the id of the last item you received. Continue while has_more is true.
The API version is part of the path (/v1). Additive changes, such as new models, new optional fields, new response fields and new error codes, are made without a version change, so ignore fields you don’t know. See the changelog.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Five API","description":"Five API generates AI videos from text, images, reference assets and clips through one REST API: pick a model, create a task, and receive the MP4 by webhook or polling.","colors":{"primary":"#4F46E5","light":"#818CF8","dark":"#4338CA"},"logo":{"light":"https://mintcdn.com/i2v/KgjMBxZ5eIs4maZs/logo/light.svg?fit=max\u0026auto=format\u0026n=KgjMBxZ5eIs4maZs\u0026q=85\u0026s=817eb9e9373c296b1e9e260b8be26b83","dark":"https://mintcdn.com/i2v/KgjMBxZ5eIs4maZs/logo/dark.svg?fit=max\u0026auto=format\u0026n=KgjMBxZ5eIs4maZs\u0026q=85\u0026s=953eeaf693a62c8e68149421ab01a708"},"favicon":"https://mintcdn.com/i2v/KgjMBxZ5eIs4maZs/favicon.svg?fit=max\u0026auto=format\u0026n=KgjMBxZ5eIs4maZs\u0026q=85\u0026s=43cb28fb3c9f167cf6eb331824c0b41c","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["bash","python","javascript","go","java","php"],"prefill":true}},"navbar":{"links":[{"href":"mailto:support@fiveapi.ai","label":"Support"}],"primary":{"type":"button","label":"Get API key","href":"https://fiveapi.ai"}},"footer":{"socials":{"website":"https://fiveapi.ai"},"links":[{"header":"Five API","items":[{"label":"Website and console","href":"https://fiveapi.ai"}]},{"header":"Support","items":[{"label":"support@fiveapi.ai","href":"mailto:support@fiveapi.ai"}]}]},"search":{"prompt":"Search the Five API docs..."},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode","download-spec"],"display":"header"},"markdown":{"instructions":["Five API is a video generation REST API. Base URL: https://api.fiveapi.ai. Authenticate with the header Authorization: Bearer \u003cAPI key>; 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"]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"i2v","hasAudioNarration":false,"actualSubdomain":"i2v","customDomains":["testweb2-docs-openapi.test765.com"],"gitSource":{"type":"github","owner":"billions-x","repo":"openapi-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae1570a0dad34c367901cb8"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae15c642f9b16126877fc9c","collectionId":"272cfea9-65cb-4404-a158-a3aec1fcfe27","liveDeploymentHistoryId":"6ae15c642f9b16126877fc9c","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1e60b5ca9b4a2f4636860","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"API reference","count":18},{"language":"default","tag":"Core concepts","count":7},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"Tasks","count":3},{"language":"default","tag":"Video Fast 1.0","count":3},{"language":"default","tag":"Wan 3.0 Spark","count":3},{"language":"default","tag":"Build with AI","count":2},{"language":"default","tag":"Account","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"API reference","sidebarTitle":"Introduction","description":"Base URL, authentication, request and response conventions of the Five API.","href":"/api-reference/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Base URL, authentication, request and response conventions of the Five API.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Five API is a REST API. You send JSON over HTTPS and get JSON back. Every endpoint page in this section has an interactive playground: add your API key and send real requests from the browser.`}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Requests from the playground are real: creating a task holds and charges credits from your balance.`})}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.fiveapi.ai`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`All endpoints live under `,_jsx(_components.code,{children:`/v1`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Send your API key in the `,_jsx(_components.code,{children:`Authorization`}),` header with the `,_jsx(_components.code,{children:`Bearer`}),` scheme, or in the `,_jsx(_components.code,{children:`x-api-key`}),` header:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.fiveapi.ai/v1/models`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$FIVEAPI_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Create keys in the `,_jsx(_components.a,{href:`https://fiveapi.ai`,children:`developer console`}),`. See `,_jsx(_components.a,{href:`/authentication`,children:`Authentication`}),` for scopes, IP allowlists and rotation.`]}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /v1/{brand}/{version}/{task}`})}),_jsxs(_components.td,{children:[`Create a task on a model, for example `,_jsx(_components.code,{children:`POST /v1/wan/v3.0-spark/image-to-video`}),`. Each model has its own page in the sidebar.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /v1/tasks/{task_id}`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/tasks/get-task`,children:`Get a task`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /v1/tasks`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/tasks/list-tasks`,children:`List tasks`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /v1/tasks/{task_id}/cancel`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/tasks/cancel-task`,children:`Cancel a task`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /v1/models`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/models/list-models`,children:`List models`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /v1/models/{brand}/{version}/{task}`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/models/get-model`,children:`Get a model`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /v1/account`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/account/get-account`,children:`Get the account`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /v1/account/usage`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/api-reference/account/get-usage`,children:`Get daily usage`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Webhook`}),_jsxs(_components.td,{children:[_jsx(_components.a,{href:`/api-reference/webhooks/task-events`,children:`Task events`}),` sent to your endpoint`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`requests`,children:`Requests`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Send `,_jsx(_components.code,{children:`Content-Type: application/json`}),` with every request that has a body.`]}),`\n`,_jsxs(_components.li,{children:[`Field names are `,_jsx(_components.code,{children:`snake_case`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Input files are public HTTPS URLs; there is no upload endpoint. See `,_jsx(_components.a,{href:`/concepts/input-files`,children:`Input files`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Create requests accept an optional `,_jsx(_components.a,{href:`/concepts/idempotency`,children:_jsx(_components.code,{children:`Idempotency-Key`})}),` header.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`responses`,children:`Responses`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Successful requests answer `,_jsx(_components.code,{children:`200 OK`}),` with a JSON object. Lists have the shape `,_jsx(_components.code,{children:`{\"object\": \"list\", \"data\": [...], \"has_more\": false}`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Ids are opaque strings with a prefix: `,_jsx(_components.code,{children:`task_...`}),`, `,_jsx(_components.code,{children:`evt_...`}),` (webhook events), `,_jsx(_components.code,{children:`acct_...`}),`, `,_jsx(_components.code,{children:`req_...`}),` (requests).`]}),`\n`,_jsxs(_components.li,{children:[`Timestamps are ISO 8601 in UTC with milliseconds, for example `,_jsx(_components.code,{children:`2026-10-23T06:21:02.127Z`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Members without a value are omitted, except `,_jsx(_components.code,{children:`error`}),` on a task, which is always present.`]}),`\n`,_jsxs(_components.li,{children:[`Every response carries `,_jsx(_components.code,{children:`X-Request-Id`}),`. Error bodies repeat it as `,_jsx(_components.code,{children:`error.request_id`}),`; include it when you contact support.`]}),`\n`,_jsxs(_components.li,{children:[`Authenticated responses carry `,_jsx(_components.code,{children:`X-RateLimit-Limit`}),`, `,_jsx(_components.code,{children:`X-RateLimit-Remaining`}),` and `,_jsx(_components.code,{children:`X-RateLimit-Reset`}),`. See `,_jsx(_components.a,{href:`/concepts/rate-limits`,children:`Rate limits`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Responses are not cacheable (`,_jsx(_components.code,{children:`Cache-Control: no-store`}),`).`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsx(_components.p,{children:`Errors use standard HTTP status codes and one JSON shape:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"billing_error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"insufficient_credits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"this task needs 60 credits, 25 are available\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"request_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"req_01M5KPQ11B3NS7R5ZFFVZBD4W3\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"required\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`60`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"available\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`25`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Branch on `,_jsx(_components.code,{children:`error.code`}),`. See `,_jsx(_components.a,{href:`/concepts/errors`,children:`Errors`}),` for every code and the retry strategy.`]}),`\n`,_jsx(Heading,{level:`2`,id:`pagination`,children:`Pagination`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`GET /v1/tasks`}),` uses cursor paging. Pass `,_jsx(_components.code,{children:`limit`}),` (1–100, default 20) and, for the next page, `,_jsx(_components.code,{children:`starting_after`}),` set to the `,_jsx(_components.code,{children:`id`}),` of the last item you received. Continue while `,_jsx(_components.code,{children:`has_more`}),` is `,_jsx(_components.code,{children:`true`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`versioning`,children:`Versioning`}),`\n`,_jsxs(_components.p,{children:[`The API version is part of the path (`,_jsx(_components.code,{children:`/v1`}),`). Additive changes, such as new models, new optional fields, new response fields and new error codes, are made without a version change, so ignore fields you don’t know. See the `,_jsx(_components.a,{href:`/changelog`,children:`changelog`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API reference","sidebarTitle":"Introduction","description":"Base URL, authentication, request and response conventions of the Five API.","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"Requests","slug":"requests","depth":2,"children":[]},{"title":"Responses","slug":"responses","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]},{"title":"Pagination","slug":"pagination","depth":2,"children":[]},{"title":"Versioning","slug":"versioning","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"i2v","siteName":"Five API","title":"API reference - Five API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T12:09:52.294Z","originalFileLocation":"api-reference/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Base URL, authentication, request and response conventions of the Five API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Five API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API reference - Five API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Base URL, authentication, request and response conventions of the Five API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Five API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://testweb2-docs-openapi.test765.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://i2v.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=API+reference\u0026amp;description=Base+URL%2C+authentication%2C+request+and+response+conventions+of+the+Five+API.\u0026amp;theme=9d2dc752b2506fd259767f0d\u0026amp;signature=8fac9b74c1ab07f08bab7984210cce078240ad7d43042ee4a7cb737fe6560dd1\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API reference - Five API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Base URL, authentication, request and response conventions of the Five API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://i2v.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=API+reference\u0026amp;description=Base+URL%2C+authentication%2C+request+and+response+conventions+of+the+Five+API.\u0026amp;theme=9d2dc752b2506fd259767f0d\u0026amp;signature=8fac9b74c1ab07f08bab7984210cce078240ad7d43042ee4a7cb737fe6560dd1\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/i2v/sgHTaltpoqdqdsUg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Five API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://testweb2-docs-openapi.test765.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://testweb2-docs-openapi.test765.com/#organization\",\"name\":\"Five API\",\"url\":\"https://testweb2-docs-openapi.test765.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/i2v/KgjMBxZ5eIs4maZs/logo/light.svg?fit=max\u0026auto=format\u0026n=KgjMBxZ5eIs4maZs\u0026q=85\u0026s=817eb9e9373c296b1e9e260b8be26b83\"}},{\"@type\":\"WebSite\",\"@id\":\"https://testweb2-docs-openapi.test765.com#website\",\"name\":\"Five API\",\"url\":\"https://testweb2-docs-openapi.test765.com\",\"publisher\":{\"@id\":\"https://testweb2-docs-openapi.test765.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://testweb2-docs-openapi.test765.com/api-reference/introduction#webpage\",\"url\":\"https://testweb2-docs-openapi.test765.com/api-reference/introduction\",\"name\":\"API reference\",\"description\":\"Base URL, authentication, request and response conventions of the Five API.\",\"dateModified\":\"2026-10-28T12:09:52.294Z\",\"isPartOf\":{\"@id\":\"https://testweb2-docs-openapi.test765.com#website\"},\"breadcrumb\":{\"@id\":\"https://testweb2-docs-openapi.test765.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://testweb2-docs-openapi.test765.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Five API\",\"item\":\"https://testweb2-docs-openapi.test765.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API reference\",\"item\":\"https://testweb2-docs-openapi.test765.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://testweb2-docs-openapi.test765.com/api-reference/introduction#article\",\"headline\":\"API reference\",\"name\":\"API reference\",\"description\":\"Base URL, authentication, request and response conventions of the Five API.\",\"url\":\"https://testweb2-docs-openapi.test765.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://testweb2-docs-openapi.test765.com/api-reference/introduction#webpage\"},\"dateModified\":\"2026-10-28T12:09:52.294Z\",\"publisher\":{\"@id\":\"https://testweb2-docs-openapi.test765.com/#organization\"},\"isPartOf\":{\"@id\":\"https://testweb2-docs-openapi.test765.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Five API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Five API","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"}]},{"group":"Video Fast 1.0","pages":[{"title":"Video Fast 1.0 — text to video","description":"Generate a video from a text prompt with **Video Fast 1.0**: fast, low-cost generation at 480p or 768p,\n3–15 seconds.\n\nThe call returns a `queued` task right away and holds `credits.estimated`. Get the video with a\n[webhook](/concepts/webhooks) or by polling [Get a task](/api-reference/tasks/get-task). Guide:\n[Text to video](/guides/text-to-video).\n","deprecated":null,"version":null,"sidebarTitle":"Text to video","openapi":"/api-reference/openapi.yaml post /v1/video-fast/v1.0/text-to-video","href":"/api-reference/video-fast-1-0/text-to-video"},{"title":"Video Fast 1.0 — image to video","deprecated":null,"version":null,"sidebarTitle":"Image to video","openapi":"/api-reference/openapi.yaml post /v1/video-fast/v1.0/image-to-video","href":"/api-reference/video-fast-1-0/image-to-video"},{"title":"Video Fast 1.0 — reference to video","deprecated":null,"version":null,"sidebarTitle":"Reference to video","openapi":"/api-reference/openapi.yaml post /v1/video-fast/v1.0/reference-to-video","href":"/api-reference/video-fast-1-0/reference-to-video"}]},{"group":"Wan 3.0 Spark","pages":[{"title":"Wan 3.0 Spark — text to video","deprecated":null,"version":null,"sidebarTitle":"Text to video","openapi":"/api-reference/openapi.yaml post /v1/wan/v3.0-spark/text-to-video","href":"/api-reference/wan-3-0-spark/text-to-video"},{"title":"Wan 3.0 Spark — image to video","deprecated":null,"version":null,"sidebarTitle":"Image to video","openapi":"/api-reference/openapi.yaml post /v1/wan/v3.0-spark/image-to-video","href":"/api-reference/wan-3-0-spark/image-to-video"},{"title":"Wan 3.0 Spark — reference to video","deprecated":null,"version":null,"sidebarTitle":"Reference to video","openapi":"/api-reference/openapi.yaml post /v1/wan/v3.0-spark/reference-to-video","href":"/api-reference/wan-3-0-spark/reference-to-video"}]},{"group":"Wan 3.0 Prime Spark","pages":[{"title":"Wan 3.0 Prime Spark — text to video","deprecated":null,"version":null,"sidebarTitle":"Text to video","openapi":"/api-reference/openapi.yaml post /v1/wan/v3.0-prime-spark/text-to-video","href":"/api-reference/wan-3-0-prime-spark/text-to-video"},{"title":"Wan 3.0 Prime Spark — image to video","deprecated":null,"version":null,"sidebarTitle":"Image to video","openapi":"/api-reference/openapi.yaml post /v1/wan/v3.0-prime-spark/image-to-video","href":"/api-reference/wan-3-0-prime-spark/image-to-video"}]},{"group":"Video Fast Extend 1.1","pages":[{"title":"Video Fast Extend 1.1 — video extend","deprecated":null,"version":null,"sidebarTitle":"Video extend","openapi":"/api-reference/openapi.yaml post /v1/video-fast/v1.1/video-extend","href":"/api-reference/video-fast-extend-1-1/video-extend"}]},{"group":"Tasks","pages":[{"title":"Get a task","deprecated":null,"version":null,"sidebarTitle":"Get task","openapi":"/api-reference/openapi.yaml get /v1/tasks/{task_id}","href":"/api-reference/tasks/get-task"},{"title":"List tasks","deprecated":null,"version":null,"sidebarTitle":"List tasks","openapi":"/api-reference/openapi.yaml get /v1/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Cancel a task","deprecated":null,"version":null,"sidebarTitle":"Cancel task","openapi":"/api-reference/openapi.yaml post /v1/tasks/{task_id}/cancel","href":"/api-reference/tasks/cancel-task"}]},{"group":"Models","pages":[{"title":"List models","deprecated":null,"version":null,"sidebarTitle":"List models","openapi":"/api-reference/openapi.yaml get /v1/models","href":"/api-reference/models/list-models"},{"title":"Get a model","deprecated":null,"version":null,"sidebarTitle":"Get model","openapi":"/api-reference/openapi.yaml get /v1/models/{brand}/{version}/{task}","href":"/api-reference/models/get-model"}]},{"group":"Account","pages":[{"title":"Get the account","deprecated":null,"version":null,"sidebarTitle":"Get account","openapi":"/api-reference/openapi.yaml get /v1/account","href":"/api-reference/account/get-account"},{"title":"Get daily usage","deprecated":null,"version":null,"sidebarTitle":"Get usage","openapi":"/api-reference/openapi.yaml get /v1/account/usage","href":"/api-reference/account/get-usage"}]},{"group":"Webhooks","pages":[{"title":"Task events","openapi":"api-reference/openapi.yaml webhook taskEvent","href":"/api-reference/webhooks/task-events"}]}]}]},"title":"API reference - Five API","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":[],"chunks":[]}
