List every route

GET

/api

curl --request GET \
  --url http://127.0.0.1:8765/api

Index of every route (method, path, effect, one line) plus the spec and agent-guide links. Start here. Every route this server answers, with its effect and cost class; follow openapi for parameters, schemas and error codes.

Responses

200

Success.

Media typeapplication/json

object

schema_version

required

Allowed value: scout-api-index:1

key

additional properties

any

Example

{
  "llms": "/llms.txt",
  "openapi": "/api/openapi.json",
  "routes": [
    {
      "effect": "read",
      "external": "none",
      "method": "GET",
      "path": "/api/health",
      "summary": "Liveness."
    }
  ],
  "schema_version": "scout-api-index:1"
}

403

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}