Skip to main content
POST
/
v1
/
browsing
/
tasks
curl --request POST \
  --url https://api.yutori.com/v1/browsing/tasks \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "task": "Give me a list of all employees (names and titles) of Yutori.",
    "start_url": "https://yutori.com"
  }'

{
  "task_id": "<string>",
  "view_url": "<string>",
  "status": "queued",
  "result": "<string>",
  "paused": true,
  "structured_result": {},
  "webhook_url": "<string>"
}
curl --request POST \
  --url https://api.yutori.com/v1/browsing/tasks \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "task": "Give me a list of all employees (names and titles) of Yutori.",
    "start_url": "https://yutori.com"
  }'

​
Advanced Example

Request structured JSON output by providing a JSON Schema. This example extracts employee data in a specific format.
curl --request POST \
  --url https://api.yutori.com/v1/browsing/tasks \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "task": "Give me a list of all employees (names and titles) of Yutori.",
    "start_url": "https://yutori.com",
    "max_steps": 75,
    "webhook_url": "https://example.com/webhook",
    "task_spec": {
      "output_schema": {
        "type": "json",
        "json_schema": {
          "type": "object",
          "properties": {
            "employees": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": { "type": "string" },
                  "title": { "type": "string" }
                },
                "required": ["name", "title"]
              }
            }
          },
          "required": ["employees"]
        }
      }
    }
  }'

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
task
string
required

String describing the browsing task in natural language.

Example:

"Give me a list of all employees (names and titles) of Yutori."

​
start_url
string
required

URL to open before running the task

Example:

"https://yutori.com"

​
max_steps
integer | null

Maximum number of steps the agent can take

Required range: 1 <= x <= 100
Example:

50

​
agent
enum<string> | null
default:navigator-n1-preview-2025-11

Which agent to use for the browsing task.

Available options:
navigator-n1-preview-2025-11,
claude-sonnet-4-5-computer-use-2025-01-24,
yutori_navigator,
anthropic_computer_use
Example:

"navigator-n1-preview-2025-11"

​
require_auth
boolean
default:false

Hint that this task is likely to involve authentication (e.g. logging in or entering passwords). When true, the system will prefer an auth-optimized browser provider when available.

​
task_spec
TaskSpec · object

Optional task specification including input and/or output JSON schemas

Example:
{
  "output_schema": {
    "json_schema": {
      "properties": {
        "employees": {
          "items": {
            "properties": {
              "name": {
                "description": "Full name of the employee",
                "type": "string"
              },
              "title": {
                "description": "Job title of the employee",
                "type": "string"
              }
            },
            "required": ["name", "title"],
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": ["employees"],
      "type": "object"
    },
    "type": "json"
  }
}
​
webhook_url
string | null

Optional webhook URL to receive the agent.run result for the calling user using webhook_format.

Example:

"https://example.com/webhook"

​
webhook_format
enum<string>
default:scout

Webhook payload format to use when webhook_url is provided. Slack incoming webhook URLs require 'slack'.

Available options:
scout,
slack,
zapier
Example:

"scout"

Response

Successful Response

​
task_id
string
required

Unique identifier for this browsing task

​
view_url
string
required
​
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed
​
result
string | null
​
paused
boolean | null
​
structured_result
Structured Result · object

If an output schema was provided, the result formatted as JSON matching that schema

​
webhook_url
string | null

Echoes the webhook URL configured for this agent.run request, if provided.