Tasks
Querying Task Status
You can check the status of any task by querying the task
API:
https://api.beam.cloud/v1/task/{TASK_ID}/status/
This API returns the following data:
- Task ID
- Time the task started, or null if it hasn’t started yet (but is in the queue)
- Time the task ended, or null if it is still running, or hasn’t started yet
- If any
Outputs
are saved: a dictionary of outputs, containing pre-signed URLs to download the files - The status of the task
Request
curl -X GET \
--header "Content-Type: application/json" \
--user "{CLIENT_ID}:{CLIENT_SECRET}" \
"https://api.beam.cloud/v1/task/{TASK_ID}/status/"
Response
{
"task_id": "edbcf7ff-e8ce-4199-8661-8e15ed880481",
"started_at": "2023-04-24T22:44:06.911920Z",
"ended_at": "2023-04-24T22:44:07.184763Z",
"outputs": {
"my-output-1": {
"path": "output_path",
"name": "my-output-1",
"url": "http://data.beam.cloud/outputs/6446df99cf455a04e0335d9b/hw6hx/hw6hx-0001/edbcf7ff-e8ce-4199-8661-8e15ed880481/my-output-1.zip?..."
}
},
"status": "COMPLETE",
}
Task Statuses
These are all possible states for a task:
Status | Description |
---|---|
PENDING | The task is enqueued and has not started yet. |
RUNNING | The task is running. |
COMPLETE | The task completed without any errors. |
RETRY | The task is being retried. Defaults to 3, unless max_retries is provided in the function decorator. |
CANCELLED | The task was cancelled by the user. |
TIMEOUT | The task timed out, based on the timeout provided in the function decorator. |
FAILED | The task did not complete successfully. |
Was this page helpful?