{ data, error } envelope used by successful responses: data is null, and error contains a human-readable description of what went wrong. An optional details object provides field-level information when available.
Error response format
details is always present on error responses. For validation errors (400) it may contain a map of field names to specific issues. For other error types it is typically an empty object {}.
Error codes
400 Bad Request
400 Bad Request
Meaning: The request was rejected because the body or query parameters are invalid or incomplete.Common causes:
- A required field is missing from the request body (e.g. omitting
titlewhen creating a prompt). - A field value is the wrong type (e.g. sending a string where an integer is expected).
- A query parameter is outside the accepted range (e.g.
limit=0orlimit=500).
- Read the
errormessage — it identifies the problem at a high level. - Check
detailsfor a field-by-field breakdown of what failed validation. - Compare your request payload against the endpoint’s parameter table in this reference.
404 Not Found
404 Not Found
Meaning: The resource identified in the request path or parameters does not exist, or is not accessible with your API key.Common causes:
- The prompt, vault, or API key ID in the URL path is incorrect or has a typo.
- The resource was deleted before the request was made.
- The resource belongs to a different account than the one associated with your API key.
- Double-check the resource ID in the URL path.
- Confirm the resource still exists by listing the collection (e.g.
GET /api/v1/prompts). - Ensure you are using the API key for the account that owns the resource.