Skip to main content
GET
/
tasks
/
{task_id}
Get Task By Id
curl --request GET \
  --url https://api.webagent.cloud/tasks/{task_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "model": "<string>",
  "provider": "<string>",
  "webhook_url": "<string>",
  "response_format": "<string>",
  "json_schema": "<string>",
  "auth_context_id": "<string>",
  "initial_url": "<string>",
  "session_timeout": 123
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
task_id
string
required

Response

Successful Response

Represents a Task

​
id
string
required

The ID of the task

​
name
string
required

The name of the task

​
prompt
string | null
required

The task to be performed by the agent

Minimum string length: 3
​
model
string | null
required

The model to use for the task. Defaults to 'gpt-4.1'.

​
provider
string | null
required

The provider to use for the task. Defaults to 'openai'.

​
webhook_url
string | null
required

The webhook URL to send the result to

​
response_format
string | null
required

Whether to return the result as text or JSON

​
json_schema
required

The JSON schema for the task result

​
auth_context_id
string | null
required

The id of associated auth context

​
initial_url
string | null
required

The initial URL to navigate to before executing the task

​
session_timeout
integer | null
required

The timeout for the task in seconds