Docs
Swagger

Scout

Setup

Create an API key, hit the Scout host, and confirm the response shape. Credits and rate limits apply from the first billed call.

  1. Get an API key

    The Scout console is not public yet. Early-access keys (sk_scout_…) are issued manually and share one credit wallet per Macrocontent account.

    Copy the secret once when you receive it — it is shown only at creation.

  2. Use the Scout base URL

    API base URL: https://api.scout.macrocontent.dev

    Interactive docs: https://api.scout.macrocontent.dev/docs

  3. Health check (no auth, 0 credits)

    bash
    curl https://api.scout.macrocontent.dev/health

    Example response:

    json
    {
  "status": "ok",
  "service": "macro-scout",
  "version": "0.5.0"
}

  4. First billed call

    Screenshot JSON costs 8 credits. Free tier allows about ~30 requests/min (see tiers).

    bash
    curl -X POST https://api.scout.macrocontent.dev/v1/screenshot/json \
  -H "Authorization: Bearer sk_scout_…" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","format":"jpeg"}'

    Example response (truncated):

    json
    {
  "status": "success",
  "url": "https://example.com",
  "final_url": "https://example.com/",
  "capture_height": 800,
  "content_type": "image/jpeg",
  "image_base64": "/9j/4AAQSkZJRgABAQ…",
  "har_base64": null,
  "timestamp": "2026-07-21T15:00:00.000Z"
}

    image_base64 is the image payload — decode it to a .jpg to confirm the shot. A 402 CREDITS_EXHAUSTED means the wallet is empty (and PAYG is off); 429 means rate limit, not empty credits.

  5. Optional: verify a domain

    Only needed for sensitive ops (journey interact/evaluate, Basic Auth, mTLS). See Domain verify.

Credits + rate limits
Free accounts start with 500 credits per period and ~30 req/min. When prepaid is empty and PAYG is off, Scout returns 402 CREDITS_EXHAUSTED. Full table: Tiers & credits.