Authentication

The API uses workspace API keys, generated in your Sillage settings. They start with sk_live_. A key gives access to the workspace it was generated for, and only to that workspace.

Header

Send the API key in the Authorization header:

Authorization: Bearer <YOUR_API_KEY>

Example request

curl "https://api.getsillage.com/api/v3/lists?page_size=5" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Status codes

Error model

Every error is an RFC 9457 problem document, sent with Content-Type: application/problem+json. It has these fields:

{
  "type": "about:blank",
  "title": "Unprocessable Entity",
  "status": 422,
  "code": "invalid_body",
  "detail": "Invalid request body",
  "instance": "/api/v3/contents/query",
  "errors": {
    "limit": ["must be at most 100"]
  }
}

An error about the request as a whole, or about several fields together, such as a missing body, is named _root. An unknown field is named in errors, under its own name:

{
  "type": "about:blank",
  "title": "Unprocessable Entity",
  "status": 422,
  "code": "invalid_body",
  "detail": "Invalid request body",
  "instance": "/api/v3/contents/query",
  "errors": {
    "keyword": ["Unknown field: keyword"]
  }
}

Input is never silently replaced by a default: an unknown field, parameter or value, an invalid date, or a cursor that does not belong to the request is refused with 422. Only a body sent with GET or DELETE is ignored.

Error codes

The code of a problem is one of these values. Branch on it, never on title or detail.

New codes may be added; for a code you don't know, act on the HTTP status.

Common response headers

Every response includes:

A 429 response also carries Retry-After, the number of seconds to wait before you retry.

Security