For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI Reference
GuidesAPI Reference
  • Overview
    • API reference
  • Search
    • POSTSearch
    • GETSearch Run List
    • GETSearch Run Get
    • GETSearch Run Events
    • POSTSearch Run Cancel
  • Extract
    • GETExtract a URL
    • POSTExtract
  • Monitors
    • GETList monitors
    • POSTCreate monitor
    • GETRetrieve monitor
    • DELDelete monitor
    • PATCHUpdate monitor
    • GETList monitor events
    • POSTMonitor Pause
    • POSTMonitor Resume
    • POSTRun monitor
  • Tasks
    • POSTTask
    • POSTCreate task run
    • GETRetrieve task run
    • GETStream task run events
    • GETTask List
    • GETTask Get
    • GETTask Events
    • POSTTask Cancel
  • Chat
    • POSTChat completion
  • Find All
    • POSTFindAll
    • GETFindall Run List
    • POSTCreate FindAll run
    • GETRetrieve FindAll run
    • GETStream FindAll run events
    • POSTCancel FindAll run
    • POSTExtend FindAll run
    • POSTEnrich FindAll run
LogoLogo
On this page
  • Base URL
  • Conventions
  • The schema
Overview

API reference

The Scout v1 API - endpoints, schemas, and interactive examples.

||View as Markdown|
Was this page helpful?
Edit this page
Next

Search

Built with

The pages in this section are generated from Scout’s OpenAPI specification and grouped by product: Search, Extract, Tasks, FindAll, Chat and Monitors. Each endpoint page documents its request and response schema and includes an interactive explorer you can call directly.

Base URL

$https://core.usescout.sh

Conventions

  • Every endpoint is under the /v1 prefix and speaks JSON over HTTPS.
  • Responses are flat JSON. Cache state and timing are returned as response headers (X-Cache, X-Elapsed-Ms) so the body stays schema-clean.
  • Most responses carry a credits field reporting the relative cost of the call.
  • Every request must include Authorization: Bearer <YOUR_API_KEY> — see Authentication.

The schema

The OpenAPI specification is also available to download or pipe into your own tooling and SDK generators.

OpenAPI (JSON)

The version-pinned schema as JSON.

OpenAPI (YAML)

The same schema as YAML.