ScoutsCreate a scout

Create a scout

Create a scout on one client. Unset fields take the skill's defaults: name from the skill, schedule daily 08:00 in the client's timezone. Needs the scouts plan feature for the client (402 feature_not_in_plan), a model key (OpenRouter, Gemini or Cloudflare) for the client or agency (409 no_model_key), a model that key can run (422 model_provider_mismatch), and on an mcp_ key the read scope of every surface the skill reads (403 insufficient_scope). At most 10 scouts per client (422 scout_limit).

provider picks the key. Sent: the client must reach a key for it (its own or the agency's), else 409 no_model_key naming it, and model must fit it (422 model_provider_mismatch). Only model sent: Mythic picks a provider the client has a key for that fits the model and stores it (the provider of the client's default key first, else the only one that fits, else OpenRouter, Cloudflare, Gemini); none fits gives 422 model_provider_mismatch listing the providers the client has keys for. null, or neither sent: the default key, which model must fit.

curl -X POST "https://mythic-analytics.gulp.workers.dev/client/v1/scouts" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "location_id": "example_string",
    "name": "John Doe",
    "skill": "error_tracking",
    "instructions": "example_string",
    "schedule": {
      "kind": "daily",
      "time": "08:00",
      "day_of_week": 42,
      "timezone": "America/New_York"
    },
    "delivery": {
      "channel_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "model": "example_string",
    "provider": "openrouter",
    "enabled": true,
    "version": 42,
    "next_run_at": "2024-12-25T10:00:00Z",
    "last_run_at": "2024-12-25T10:00:00Z",
    "last_report_at": "2024-12-25T10:00:00Z",
    "last_error": "example_string",
    "current_run": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "scheduled_for": "2024-12-25T10:00:00Z",
      "triggered_by": "schedule",
      "attempts": 42
    },
    "can_run_now": true,
    "created_at": "2024-12-25T10:00:00Z",
    "updated_at": "2024-12-25T10:00:00Z"
  }
}
POST
/client/v1/scouts
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.
Content-Typestring
Required

The media type of the request body

Options: application/json
No request body parameters defined
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Body

application/json
datastring
Required

Raw application/json data

Responses