Create A Scout

POST

scouting

tasks

curl --request POST \
  --url https://api.yutori.com/v1/scouting/tasks \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
  }'

import requests

response = requests.post(
    "https://api.yutori.com/v1/scouting/tasks",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "query": "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
    }
)
print(response.json())

const response = await fetch("https://api.yutori.com/v1/scouting/tasks", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    query: "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
  })
});
const data = await response.json();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "display_name": "<string>",
  "next_run_timestamp": "2023-11-07T05:31:56Z",
  "user_timezone": "<string>",
  "next_output_timestamp": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "paused_at": "2023-11-07T05:31:56Z",
  "output_schema": {},
  "query_object": {},
  "is_public": false,
  "view_url": "<string>",
  "webhook_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

curl --request POST \
  --url https://api.yutori.com/v1/scouting/tasks \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
  }'

import requests

response = requests.post(
    "https://api.yutori.com/v1/scouting/tasks",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "query": "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
    }
)
print(response.json())

const response = await fetch("https://api.yutori.com/v1/scouting/tasks", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    query: "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
  })
});
const data = await response.json();

Advanced Example

Receive structured output on a webhook when the task completes

Configure structured output with output_schema to receive data in a specific JSON schema format, and optionally add webhook notifications.

curl --request POST \
  --url https://api.yutori.com/v1/scouting/tasks \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori",
    "output_interval": 86400,
    "user_timezone": "America/Los_Angeles",
    "skip_email": true,
    "webhook_url": "https://example.com/webhook",
    "output_schema": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "headline": { "type": "string" },
          "summary": { "type": "string" },
          "source_url": { "type": "string" }
        }
      }
    }
  }'

import requests

response = requests.post(
    "https://api.yutori.com/v1/scouting/tasks",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "query": "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori",
        "output_interval": 86400,
        "user_timezone": "America/Los_Angeles",
        "skip_email": True,
        "webhook_url": "https://example.com/webhook",
        "output_schema": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "headline": {"type": "string"},
                    "summary": {"type": "string"},
                    "source_url": {"type": "string"}
                }
            }
        }
    }
)
print(response.json())

const response = await fetch("https://api.yutori.com/v1/scouting/tasks", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    query: "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori",
    output_interval: 86400,
    user_timezone: "America/Los_Angeles",
    skip_email: true,
    webhook_url: "https://example.com/webhook",
    output_schema: {
      type: "array",
      items: {
        type: "object",
        properties: {
          headline: { type: "string" },
          summary: { type: "string" },
          source_url: { type: "string" }
        }
      }
    }
  })
});
const data = await response.json();

Authorizations

x-api-key

string

header

required

Body

application/json

query

string

required

String describing what to monitor in natural language.
    This is typically what a user types into the Scouts web UI (without any frequency preferences).

Example:

"Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori, the AI company."

output_schema

Output Schema · object | null

JSON Schema for structured output. Takes precedence over task_spec if both provided.

Example:

{
  "items": {
    "properties": {
      "headline": {
        "description": "News headline",
        "type": "string"
      },
      "summary": {
        "description": "Brief summary",
        "type": "string"
      },
      "source_url": {
        "description": "URL for more details",
        "type": "string"
      }
    },
    "type": "object"
  },
  "type": "array"
}

task_spec

TaskSpec · object | null

deprecated

Deprecated but still supported. Use output_schema instead.

Show child attributes

used_deprecated_task_spec

boolean

default:false

output_interval

integer

default:86400

Interval in seconds of how often to run the task. This must be >= 1800 (= 30 minutes).
    On the web UI, this is inferred from what the user types into the new scout input (e.g. "daily at 9am").
    Recommended: 86400 (daily) or 3600 (hourly).

Example:

3600

start_timestamp

integer

default:0

Unix timestamp (past, present, or future) of when the scout should start running.
    If past, present, or up to 30 min in the future, the scout will start running immediately.
    Else, the scout will start running at the specified timestamp.

Example:

0

user_timezone

string

default:America/Los_Angeles

String indicating the user's timezone (e.g. "America/Los_Angeles")
    On the web UI, this is inferred from the browser's timezone.
    Default: "America/Los_Angeles".

Example:

"America/Los_Angeles"

user_location

string | null

default:San Francisco, CA, US

String indicating the user's coarse location in the format: city, region_code, country_name.
    On the web UI, this is inferred from the browser's location.
    Default: "San Francisco, CA, US".

Example:

"San Francisco, CA, US"

skip_email

boolean

default:true

If true, email notifications will be skipped and only webhook notifications will be sent.
    Email subscriptions will still be stored but no emails will be sent.
    Default: true (sends webhooks only).

Example:

true

webhook_url

string | null

Optional webhook URL to receive updates for this scout. Creates a webhook subscription for the calling user using webhook_format.

Example:

null

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"

is_public

boolean

default:false

Whether the scout is publicly accessible (true) or private (false).
    Public scouts can be accessed by anyone via the UUID link.
    Private scouts can only be accessed by the creator.
    Default: false (private).

Response

Successful Response

Public API response for scout creation. Excludes internal fields like llm_output.

string<uuid>

required

query

string

required

display_name

string

required

next_run_timestamp

string<date-time> | null

required

user_timezone

string

required

next_output_timestamp

string<date-time> | null

required

created_at

string<date-time>

required

completed_at

string<date-time> | null

required

paused_at

string<date-time> | null

required

output_schema

Output Schema · object | null

required

JSON Schema for structured output, if configured

query_object

Query Object · object | null

rejection_reason

enum<string> | null

Available options:

insufficient_prepaid_balance,

budget_exceeded,

subscription_inactive

is_public

boolean

default:false

view_url

string | null

URL to view this scout's details in the API platform dashboard.

webhook_url

string | null

Optional webhook URL configured for this scout, if provided at creation time.

Partially Update A ScoutUpdate specific fields of an existing Scout. Only provided fields will be updated; omitted fields remain unchanged.

curl --request POST \
  --url https://api.yutori.com/v1/scouting/tasks \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
  }'

import requests

response = requests.post(
    "https://api.yutori.com/v1/scouting/tasks",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "query": "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
    }
)
print(response.json())

const response = await fetch("https://api.yutori.com/v1/scouting/tasks", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    query: "Tell me about the latest news, product updates, press releases, social media announcements, investments into, or other relevant information about Yutori"
  })
});
const data = await response.json();

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "display_name": "<string>",
  "next_run_timestamp": "2023-11-07T05:31:56Z",
  "user_timezone": "<string>",
  "next_output_timestamp": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "paused_at": "2023-11-07T05:31:56Z",
  "output_schema": {},
  "query_object": {},
  "is_public": false,
  "view_url": "<string>",
  "webhook_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Getting Started

General

Navigator API

Browsing API

Research API

Scouting API

Webhooks

Advanced Example

Authorizations

Body

Response

​Advanced Example

Authorizations

Body

Response

Advanced Example