REST API · Kestrel Docs

Base URL

https://api.kestrel.dev/v1

Send your API key as a bearer token on every request.

Terminal

curl https://api.kestrel.dev/v1/runs \
  -H "Authorization: Bearer $KESTREL_API_KEY"

Errors use HTTP status codes and a JSON body with a type and a message written for a person.

JSON

{
  "error": {
    "type": "forbidden",
    "message": "This key can't see acme/billing. Give it access in Settings → API keys."
  }
}

Status	`type`
400	`invalid_request`
401	`auth`
403	`forbidden`
404	`not_found`
409	`conflict`, for example killing a sandbox twice
429	`rate_limited`
5xx	`server`

List endpoints return 20 items by default, up to 100 with limit. Pass the next cursor from a response to get the page after it.

JSON

{ "data": [ ... ], "next": "cur_7Hc2" }