API reference
Base URL, authentication, versioning and content types for the Silvertext API, and every endpoint a key can reach.
- Base URL
- https://api.silvertext.com
- Version
- /v1 in the path
- Auth
- Authorization: Bearer st_live_…
- Format
- JSON in and out; files as JSON, multipart or raw body
Endpoints
| Endpoint | Scope | |
|---|---|---|
| POST | /v1/checks | checks:write |
| GET | /v1/checks | checks:read |
| GET | /v1/checks/{id} | checks:read |
| POST | /v1/checks/{id}/cancel | checks:write |
| DELETE | /v1/checks/{id} | checks:write |
| GET | /v1/me/usage | usage:read |
| GET | /v1/config | none (public) |
Every endpoint page carries the parameters, the response schema, examples in seven languages and a playground that calls the live API with your key. The key you paste into the playground is kept in your browser only.
Versioning
The API is versioned in the path. Fields are only ever added to /v1 responses; a field is never removed or renamed and an enum never loses a value without a new version. Treat unknown fields and unknown enum values as something to ignore, not an error.
The raw spec
The OpenAPI document these pages are generated from is at https://api.silvertext.com/openapi.json. Point a client generator or an agent at it.