Get Task Status
GET/api/v1/tasks/:businessType/:taskId
Poll a task created by a generation endpoint until status reaches a terminal value (SUCCESS, FAIL, ERROR, or OTHER). Use the businessType returned by the create call. On SUCCESS, read data.generateUrl.
Request
Responses
- 200
- 401
- 404
- 429
- 500
- 503
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
Unauthorized — missing or invalid API key.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
Task not found.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
A per-key or service-wide call-rate limit was exceeded. Retry according to the response headers.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
Limit for the scope that rejected the request.
Remaining capacity for the rejecting scope; normally 0 on a 429 response.
Unix timestamp in seconds when the rejecting scope is expected to reset.
Minimum number of seconds to wait before retrying.
Rejecting scope: api_key_minute, api_key_hour, global_minute, global_hour, or api_key_active_tasks.
An unexpected server-side error occurred.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
A protective service or dependency is temporarily unavailable. Retry with backoff.
Response Headers
Request identifier generated or accepted by the server. Use this value when contacting support.
Minimum number of seconds to wait before retrying.