Create a task
Create a new task to repeatedly perform an action on an external website.
Once created and ready, it can be repeatedly executed using the run endpoint.
Authorizations
Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>
Body
Response
Successful response
Unique identifier for the object.
"task_0R3kPq8mWxYz1aBcDeFgHi"
Current state of the task, in particular whether it is ready to use.
not_ready, waiting_for_manual_completion, ready, failed "ready"
Short title shown in the dashboard. Informational only.
"Recent store orders"
Detailed explanation of the task to be performed.
"Fetch the most recent orders from the signed-in user's account."
The primary URL the task targets. May be null while the task is not ready; non-null once generation completes.
1 - 2083"https://shop.example.com"
Task input schema as a JSON Schema object. May be null while the task is not ready (e.g. schema generation in progress). Guaranteed non-null when current_state is ready.
{
"properties": { "limit": { "type": "integer" } },
"required": [],
"type": "object"
}Task output schema as a JSON Schema object. May be null while the task is not ready (e.g. schema generation in progress). Guaranteed non-null when current_state is ready.
{
"properties": {
"orders": {
"items": {
"properties": {
"id": { "type": "string" },
"total": { "type": "number" }
},
"type": "object"
},
"type": "array"
}
},
"required": ["orders"],
"type": "object"
}Parameters set during the creation of this task.
Timestamp when the object was created.
"2026-01-01T12:00:00Z"
Timestamp when the object was last updated.
"2026-01-06T12:05:00Z"
List of secrets that must be provided when running this task.
Failure information if the task failed, including user-friendly explanation and suggestions