Skip to navigation

API · Tasks · Get the result/status of an async (Celery) task by ID

View as Markdown

Retrieve the status and result of an async task by its task_id. Status values: PENDING, STARTED, SUCCESS, FAILURE, RETRY, REVOKED.

Note: for most async tools (generateImage, media/* operations) the toolkit middleware already polls this for you and returns the final result — you rarely need to call it directly. Use it manually only when a long job (e.g. video generation) exceeds the auto-poll window and you got a task_id back.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_idstringRequired
Celery task ID

Response

Task status and result

Errors

404
Not Found Error