Errors

Reference for all error codes returned by the Oz platform API. Each error includes an HTTP status, machine-readable code, and actionable resolution steps.

When the Oz platform API encounters an error, it returns a structured JSON response following RFC 7807 (Problem Details for HTTP APIs)arrow-up-right. Every error response includes a machine-readable error code, a human-readable message, and metadata to help you diagnose and resolve the issue.


Response format

All error responses share this structure:

{
  "type": "https://docs.warp.dev/reference/api-and-sdk/troubleshooting/errors/invalid-request",
  "title": "The request contains invalid or missing parameters.",
  "status": 400,
  "detail": "schedule_id is required",
  "instance": "/api/v1/agent/tasks",
  "error": "The request contains invalid or missing parameters. (schedule_id is required)",
  "retryable": false,
  "trace_id": "abc123def456..."
}

Error responses use the application/problem+json content type per RFC 7807.

Field reference

  • type — A URI identifying the error type. Links to the documentation page for that error.

  • title — A short, human-readable summary of the problem.

  • status — The HTTP status code for this response.

  • detail — Additional context specific to this occurrence of the error. Not always present.

  • instance — The request path that produced the error.

  • error — A backward-compatible field combining title and detail (for older clients). When detail is present, formatted as "title (detail)".

  • retryable — Whether this request can be retried. If true, the platform may automatically retry the operation.

  • trace_id — An OpenTelemetry trace ID, included when available. Reference this when contacting support.

Some errors include additional metadata fields (for example, auth_url, provider, or inaccessible_repos). These are documented on each error's page.


Error categories

Errors are split into two categories based on what caused the failure:

User errors

These indicate something the caller needs to fix. When a cloud agent task encounters a user error, the task transitions to the FAILED state.

Platform errors

These indicate a Warp-side issue. When a cloud agent task encounters a platform error, the task transitions to the ERROR state. Retryable errors are automatically retried before the task is marked as failed.


Using the trace_id

When an error response includes a trace_id, you can include it when contacting Warp supportarrow-up-right to help the team locate the specific request in internal logs. This is especially useful for internal_error and resource_unavailable errors.


Last updated

Was this helpful?