API reference
The Vitrified REST API: authentication, base URL, resource shapes, error envelope, and the live endpoint reference.
API reference
The Vitrified API is a JSON-over-HTTPS REST API. Every SDK call eventually hits this surface. You
can also call it directly with curl or any HTTP client.
Base URL
https://api.vitrified.glassAll endpoints are versioned under /v1/.
Authentication
Every request requires a Bearer token (API key). Generate keys from the dashboard's API keys page. Keys are scoped to a single project.
GET /v1/attestations/sub_01J... HTTP/1.1
Host: api.vitrified.glass
Authorization: Bearer vit_live_...Idempotency
Mutating endpoints accept an optional Idempotency-Key header. Two requests with the same
idempotency key within the retention window (default 24h) return the same resource. The
idempotency key is per-API-key.
Resource identifiers
Vitrified uses ULID-style prefixed identifiers:
| Resource | Prefix | Example |
|---|---|---|
| Submission | sub_ | sub_01J7K3F2X8Y9Z0A1B2C3D4E5 |
| Batch | btc_ | btc_01J7K3F2X8Y9Z0A1B2C3D4E5 |
| API key | vit_live_ / vit_test_ | vit_live_abc123... |
| Webhook subscription | whk_ | whk_01J7K3F2X8Y9Z0A1B2C3D4E5 |
| Export job | exp_ | exp_01J7K3F2X8Y9Z0A1B2C3D4E5 |
Error envelope
{
"error": {
"code": "submission.invalid_metadata",
"message": "Metadata failed validation against schema 'slsa.provenance.v1'.",
"details": {
"schema": "slsa.provenance.v1",
"errors": [{ "path": "/predicate/builder/id", "message": "must be a URI" }]
},
"request_id": "req_01J..."
}
}The full error code vocabulary is pinned in
spec/errors.md.
Rate limits
| Bucket | Default |
|---|---|
| Submissions | 60 / sec, 10k / hour, 100k / day |
| Reads | 600 / sec |
| Webhook deliveries | 100 / sec, bursting to 1k |
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers.
OpenAPI
A machine-readable OpenAPI 3.1 spec is published at:
https://api.vitrified.glass/openapi.jsonGenerate clients with openapi-typescript-codegen, openapi-generator, or any compatible
tooling.
Endpoint reference
See Endpoints for the per-endpoint reference (request shapes, response shapes, error codes).
See also
- JavaScript SDK — preferred client for Node / browser.
- Python SDK — preferred client for Python.
- Webhooks — the events you can subscribe to.
Test artifact attestation
Attest test fixtures, evaluation outputs, and Playwright snapshots so downstream consumers can verify exactly what was tested.
Endpoints
Per-endpoint reference for the Vitrified REST API: request and response shapes for attestations, bundles, webhooks, exports, and admin.
Was this page helpful?