> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Récupérer une vidéo Flux 3
> Récupérez une tâche vidéo Flux 3 par ID de tâche, y compris son état, sa progression, ses horodatages, l’URL du résultat ou les détails de l’échec.
Utilisez ce point de terminaison après avoir créé une tâche vidéo Flux 3. La réponse inclut `video_url` lorsque la tâche est terminée.
## Vérifiez ces champs
* `status` est `queued`, `in_progress`, `completed` ou `failed`.
* `progress` est un pourcentage approximatif de réalisation allant de `0` à `100`.
* `video_url` apparaît lorsque la tâche est terminée.
* `error` apparaît lorsque la tâche échoue.
## Interroger la tâche
Commencez par [Créer une vidéo Flux 3](./create) et enregistrez la valeur `id` renvoyée.
Envoyez l’ID de la tâche à ce point de terminaison jusqu’à ce que `status` soit `completed` ou `failed`.
Lorsque `status` est `completed`, appelez [Télécharger le contenu vidéo Flux 3](./retrieve-content).
## OpenAPI
````yaml api/openapi/video/flux-3/get-retrieve.openapi.json GET /v1/videos/{task_id}
openapi: 3.1.0
info:
title: Flux 3 Video Retrieve API
version: 1.0.0
description: >-
Retrieve a Flux 3 video task by task ID. Poll this endpoint until the status
is completed or failed.
servers:
- url: https://api.cometapi.com
security:
- bearerAuth: []
paths:
/v1/videos/{task_id}:
get:
summary: Retrieve a Flux 3 video task
description: >-
Read the state of a Flux 3 video task that was created through POST
/v1/videos.
operationId: flux_3_retrieve_video
parameters:
- name: task_id
in: path
required: true
description: Task ID returned by POST /v1/videos.
schema:
type: string
example:
responses:
'200':
description: Current Flux 3 video task state.
content:
application/json:
schema:
$ref: '#/components/schemas/Flux3VideoTask'
examples:
queued:
summary: Task queued
value:
id:
task_id:
object: video
model: flux-3
status: queued
progress: 0
created_at: 1779938152
in_progress:
summary: Task in progress
value:
id:
object: video
model: flux-3
status: in_progress
progress: 30
created_at: 1779938152
completed:
summary: Task completed
value:
id:
object: video
model: flux-3
status: completed
progress: 100
created_at: 1779938152
completed_at: 1779938219
expires_at: 1780543019
video_url: https://media.example.com/flux-3-result.mp4
failed:
summary: Task failed
value:
id:
object: video
model: flux-3
status: failed
progress: 100
created_at: 1779938152
completed_at: 1779938219
error:
message: The video task could not be completed.
code: generation_failed
'401':
description: The API key is missing or invalid.
'404':
description: No video task matches the supplied task ID.
security:
- bearerAuth: []
x-codeSamples:
- lang: Shell
label: Retrieve task status
source: |-
curl "https://api.cometapi.com/v1/videos/" \
-H "Authorization: Bearer $COMETAPI_KEY"
- lang: Python
label: Retrieve task status
source: |
import os
import requests
task_id = ""
response = requests.get(
f"https://api.cometapi.com/v1/videos/{task_id}",
headers={
"Authorization": "Bearer " + os.environ["COMETAPI_KEY"]
},
timeout=60,
)
response.raise_for_status()
print(response.json())
- lang: JavaScript
label: Retrieve task status
source: |
const taskId = "";
const response = await fetch(
`https://api.cometapi.com/v1/videos/${taskId}`,
{ headers: { Authorization: `Bearer ${process.env.COMETAPI_KEY}` } },
);
if (!response.ok) {
throw new Error(await response.text());
}
console.log(await response.json());
components:
schemas:
Flux3VideoTask:
type: object
required:
- id
- object
- model
- status
- progress
- created_at
properties:
id:
type: string
description: Task ID. Use this value as task_id in retrieve and content requests.
example:
task_id:
type: string
description: >-
Compatibility alias for id. This field can be omitted from retrieve
responses.
example:
object:
type: string
const: video
description: Object type for the asynchronous video task.
model:
type: string
const: flux-3
description: Model ID that the task uses.
status:
type: string
enum:
- queued
- in_progress
- completed
- failed
description: Task lifecycle status. Poll until the value is completed or failed.
progress:
type: integer
minimum: 0
maximum: 100
description: Task progress as a coarse percentage.
created_at:
type: integer
format: int64
description: Task creation time as a Unix timestamp in seconds.
completed_at:
type: integer
format: int64
description: >-
Task completion time as a Unix timestamp in seconds when the task
provides one.
expires_at:
type: integer
format: int64
description: >-
Result expiration time as a Unix timestamp in seconds when the task
provides one.
video_url:
type: string
format: uri
description: Video delivery URL. This field appears on completed tasks.
example: https://media.example.com/flux-3-result.mp4
error:
type: object
description: Failure details. This field appears when the task fails.
properties:
message:
type: string
description: Human-readable failure description.
code:
type: string
description: Failure code when the task provides one.
additionalProperties: true
additionalProperties: true
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Bearer authentication. Use your CometAPI API key.
````