REFERENCE
HTTP API reference
Build integrations or troubleshoot API calls. For the Quickstart, your coding agent handles the API.
HTTP API
For integrations, send a bearer API key to the API origin shown in the workspace. The documentation stays on this website; the storage API uses the Convex origin.
Each API route needs credentials, but the sign-in guide. Read the sign-in guide or download OpenAPI from this website. After sign-in, an agent reads the agent guide at /api/v1/agent-guide.
| GET /api/v1/examples | List public request and graph examples |
|---|---|
| GET /api/v1/operators | List the ONNX and Torch operator systems |
| GET /api/v1/operators/onnx | List the checked ONNX operator definitions |
| GET /api/v1/operators/torch | List the Torch releases with an extracted catalog, and the resolver links |
| POST /api/v1/requests/check | Check the request alone; every finding, no extra file bytes |
| POST /api/v1/requests/validate | Check a whole bundle without storing |
| POST /api/v1/requests | Upload a bundle |
| GET /api/v1/requests | List requests |
| GET /api/v1/requests/ID | Inspect a request |
| GET /api/v1/requests/ID/bundle | Download a bundle |
| GET /api/v1/requests/ID/responses | List what the service returned |
| GET /api/v1/requests/ID/responses/NAME | Download a response |
The upload body is JSON with the complete request document, an objects map from object IDs to padded base64 content, and an optional validation client report. A JSON file of the request writes its value under content in its files entry, so it needs no entry in objects and one request document shows everything that is sent. The check body is the request alone; the answer is a server validation report listing every finding with its pointer and repair, with status 200 whether or not the request passed. Accepted bundles also return and store this server report.
Explore the schema field reference for required fields, nested structures, and allowed values. Download the bundle, workload request, authoritative graph, or custom operator, or Torch catalog, or validation report schema when building an integration.
Limits and access
| Encoded upload | 8 MiB total, including base64 overhead |
|---|---|
| Request JSON | 2 MiB |
| Client validation report | 512 KiB |
| Objects per bundle | 128 |
| API key lifetime | 90 days; revoke anytime |
Keep your API key private. It can upload, list, and download requests in your workspace.
Changing a request
Each request has a lineage name and revision name. Uploads are immutable: the same names cannot identify different content.
When you change a request, use a new revision and set its parent to the previous revision digest. The workspace keeps both versions.
Troubleshooting
- Unauthorized: check that your API key is set and has not expired or been revoked.
- Revision conflict: use a new revision name for changed content.
- Content mismatch: rebuild the complete bundle and upload it again.