Skip to main content
GET
/
task
/
{task_id}
curl -X GET "https://api.smooth.sh/api/v1/task/YOUR_TASK_ID" \
     -H "apikey: YOUR_API_KEY"
{
  "id": "<string>",
  "status": "waiting",
  "output": "<any>",
  "credits_used": 123,
  "credits_balance": 123,
  "device": "desktop",
  "live_url": "<string>",
  "recording_url": "<string>",
  "downloads_url": "<string>",
  "created_at": 123
}

Authorizations

​
apikey
string
header
required

Path Parameters

​
task_id
string
required

Query Parameters

​
downloads
boolean

Whether to download the task result files after the task is completed. If true, the response will include the download link for the files.

Response

Successful Response: The task has completed (status is 'done' or 'failed').

Task response model.

​
id
string
required

The ID of the task.

​
status
enum<string>
required

The status of the task.

Available options:
waiting,
running,
done,
failed,
cancelled
​
output
any

The output of the task.

​
credits_used
integer | null

The amount of credits used to perform the task.

​
credits_balance
integer | null

The amount of credits remaining on the account.

​
device
enum<string> | null

The device type used for the task.

Available options:
desktop,
mobile
​
live_url
string | null

The URL to view and interact with the task execution.

​
recording_url
string | null

The URL to view the task recording.

​
downloads_url
string | null

The URL to download files generated during the task.

​
created_at
integer | null

The timestamp when the task was created.