Skip to main content
Platform API Docs

Errors and Troubleshooting

Interpret safe API errors and resolve common envelope, authentication, scope, and publication failures.

Version Public contract v1 Generated references follow approved public contract hashes Reviewed Jul 26, 2026 Next review Oct 26, 2026

The free Developer workspace is for non-production building and learning under published limits. External API or MCP client credentials use a separate scoped request and approval process.

Owner: Batoi Developer Experience Reviewed by: Batoi Platform Security Source revision: upgrade-jul-26-2026

Browse Batoi Platform API Documentation Errors and Troubleshooting

Errors and Troubleshooting

StatusMeaningNext action
400Invalid JSON, envelope, method, schema, or required field.Compare the request with the active operation schema.
401Client, bearer credential, audience, expiry, or revocation failed.Confirm the binding and rotate if necessary.
403Required scope or approval grant is absent.Request the minimum appropriate grant.
404Gateway, operation, or active publication is unavailable to this binding.Confirm environment and publication state.
405HTTP or logical operation method differs.Use POST at the gateway and the contracted logical method.
429Operation rate policy exceeded.Back off with jitter.
5xxRuntime, schema installation, contract integrity, or certified handler failed.Retain the request ID and contact support.

Error responses include a stable error.code, safe error.message, UTC timestamp, and request_id. They do not return stack traces, credentials, private contract definitions, or unrestricted payloads.

Diagnostic checklist

  • Use https://batoi.com/api/ unless compatibility requires the configured host.
  • Preserve the POST method, body, and authorization header.
  • Confirm client ID, gateway UID, environment, operation, and scope belong to the same binding.
  • Compare the returned contract hash with the published reference.
  • Provide only the correlation identifier to support; never attach credentials or unrestricted payloads.