Skip to main content
POST
/
v1
/
scouting
/
tasks
Create Scout Task
curl --request POST \
  --url https://api.yutori.com/v1/scouting/tasks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>",
  "output_interval": 86400,
  "start_timestamp": 0,
  "user_timezone": "America/Los_Angeles",
  "user_location": "San Francisco, CA, US",
  "task_spec": {
    "output_schema": {
      "json_schema": {},
      "type": "json"
    }
  },
  "skip_email": false,
  "webhook_url": "<string>"
}
'
{
  "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",
  "query_object": {},
  "is_public": true,
  "webhook_url": "<string>"
}
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",
    "start_timestamp": 0,
    "output_interval": 86400,
    "user_timezone": "America/Los_Angeles",
    "user_location": "San Francisco, CA, US",
    "skip_email": false,
    "webhook_url": "https://example.com/webhook",
    "task_spec": {
      "output_schema": {
        "type": "json",
        "json_schema": {
          "type": "object",
          "properties": {
            "stories": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "news": {
                    "type": "string",
                    "description": "1 sentence update"
                  },
                  "source": {
                    "type": "string",
                    "description": "URL for more details"
                  }
                },
                "required": ["news", "source"]
              }
            }
          },
          "required": ["stories"]
        }
      }
    }
  }'

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 the user types into the UI (without any frequency preferences).
    e.g. "Tell me about the latest news, product updates, press releases, social media announcements,
    investments into, or other relevant information about Yutori"
​
output_interval
integer
default:86400
Interval in seconds of how often to run the task. This must be >= 3600 (= 1 hour).
    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).
​
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.
​
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".
​
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".
​
task_spec
TaskSpec · object

Task specification with JSON output schema for structured updates

​
skip_email
boolean
default:false
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: false (sends both emails and webhooks).
​
webhook_url
string | null

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

Response

Successful Response

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

​
id
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
​
query_object
Query Object · object
​
is_public
boolean
default:true
​
webhook_url
string | null

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