{
"status_code": 401,
"title": "Unauthorized",
"message": "Invalid API key.",
"trace_id": "",
"event_id": null
}
Zatomic API
- Overview
- Versioning
- Authentication
- Workspaces
- Status Codes and Errors
- Token Usage
- Expanding Objects
- OpenAPI Spec
- Prompts
- The Prompt Object
- Create Prompt
- Update Prompt
- Delete Prompt
- Retrieve Prompt
- Retrieve All Prompts
- Generate Prompt
- Versions
- The Version Object
- Create Version
- Update Version
- Delete Version
- Retrieve Version
- Retrieve All Versions
- Calculate Version Score
- Retrieve Version Score
- Analyze Version Risk
- Retrieve Version Risk
- Analyze Version Balance
- Retrieve Version Balance
- Generate Version Heatmap
- Retrieve Version Heatmap
- Improve Version
- Scoring Criteria
- The Scoring Criteria Object
- The Scoring Criterion Object
- Create Scoring Criteria
- Update Scoring Criteria
- Delete Scoring Sriteria
- Retrieve Scoring Criteria
- Retrieve All Scoring Criteria
- Generate Scoring Criteria
- Create Scoring Criterion
- Update Scoring Criterion
- Delete Scoring Criterion
- Retrieve Scoring Criterion
- Scoring Criteria Results
- The Scoring Criteria Results Object
- Scoring
- The Scoring Object
- Calculate Prompt Score
- Risk
- The Risk Object
- Analyze Prompt Risk
- Balance
- The Balance Object
- Analyze Prompt Balance
- Heatmaps
- The Heatmap Object
- Generate Prompt Heatmap
Status Codes and Errors
Zatomic uses standard HTTP status codes to indicate success or failure of API requests. In general, 2xx codes represent success, 4xx codes indicate a bad request (such as an invalid API key), and 5xx codes mean something went wrong on our end (which should be rare).
HTTP Status Codes | ||
---|---|---|
200 | OK | The request was successful. |
201 | Created | The resource was created. |
204 | No Content | The resource was deleted. |
400 | Bad Request | The request was unacceptable. |
401 | Unauthorized | Invalid API key or invalid API client ID. |
403 | Forbidden | The API key doesn't have permissions. |
404 | Not Found | The requested resource doesn't exist. |
429 | Too Many Requests | Too many requests hit the API too quickly. |
500 | Internal Server Error | Something went wrong on Zatomic's end. |
Error Response