Skip to main content
Use structured Agent SDK errors when your application needs to decide whether to retry, ask the user for different input, or show request details to an operator.

Handle gateway failures

Gateway failures are rethrown as AgentGatewayError:
Failed runs and steps retain gateway error details when they are available.

Handle schema failures

AgentSchemaValidationError identifies invalid tool input, tool output, progress events, or final output. Treat these as contract failures rather than transient model failures.

Inspect the failed run

When the runtime can checkpoint the failure, inspect:
  • result.run.status
  • result.run.error
  • the latest step’s status, error, and modelAttempts
  • requestId and nativeResponseId for correlation with gateway logs

Common checks

  • Confirm PHASEO_API_KEY is available to the server process.
  • Give each tool a unique, stable id.
  • Use exact tool-call IDs when approving, rejecting, or supplying manual output.
  • Keep model retries bounded; validation and approval failures should not retry blindly.
  • Persist paused run state before returning control to a browser or queue worker.
Last modified on July 26, 2026