Errors

Read the envelope first

APIMUX responses use a success-or-error envelope. If a request fails, inspect the error object before retrying or changing parameters.

In CLI workflows, use --debug when you need the full response envelope:

apimux --debug amazon get_product --asin B0CM5JV26D --market US

Common recovery patterns

• Authentication failure: verify the bearer token or CLI config
• Validation failure: inspect the capability schema and correct the request shape
• Upstream timeout or provider unavailability: retry with backoff
• Rate limiting: slow down and retry later

Partial success

Some capabilities can return usable data with partial upstream failure. When you are integrating with automation or agents, do not treat missing subresults as zero or empty-by-default without checking the metadata.

Source of truth

For the exact response model, error schema, and per-capability request shape, use:

• /settings/api-docs
• GET /v1/schema/{capability}
• apimux schema show <capability>