Sign in

v1

latestOpenAPI 3.1.02026-07-26194149.1 KB
Scouting

Create Scout Task

post/v1/scouting/tasks

Request body

output_schemaobject nullable

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

used_deprecated_task_specboolean
querystring 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).
output_intervalinteger
    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).
start_timestampinteger
    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_timezonestring
    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_locationstring nullable
    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".
skip_emailboolean
    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).
webhook_urlstring nullable

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

webhook_format'scout' | 'slack' | 'zapier'

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

is_publicboolean
    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).

Example request

{
  "output_schema": {
    "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"
  },
  "query": "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_interval": 3600,
  "user_timezone": "America/Los_Angeles",
  "user_location": "San Francisco, CA, US",
  "skip_email": true,
  "webhook_format": "scout"
}

Response

Successful Response

idstring uuid required
querystring required
query_objectobject nullable
display_namestring required
next_run_timestampstring date-time nullable required
user_timezonestring required
next_output_timestampstring date-time nullable required
created_atstring date-time required
completed_atstring date-time nullable required
paused_atstring date-time nullable required
rejection_reason'insufficient_prepaid_balance' | 'budget_exceeded' | 'subscription_inactive'
is_publicboolean
view_urlstring nullable

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

webhook_urlstring nullable

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

output_schemaobject nullable required

JSON Schema for structured output, if configured