[4.6.0] Add custom error response formatting for AI APIs

[VenukshiMendis]

Summary

• Documents the new apim.ai.custom_error_response_sequence configuration, which lets users format gateway error responses for AI APIs using a custom Synapse sequence.
• Explains the default openai_error_response_formatter sequence and the OpenAI-compatible error response it produces, and how to customize it.
• Notes that this configuration applies only to AI APIs (non-AI APIs and AI APIs without this configured continue to use the default error response format)
• Adds guidance on redeploying already-deployed AI APIs after enabling this configuration, and on copying the relevant sequence files for pre-existing tenants.
• Adds a note that in a distributed deployment, this configuration must be added to both the API Control Plane (ACP) and the Universal Gateway nodes.
• Adds custom_error_response_sequence to the Config Catalog under API-M AI configurations.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 84657154-9c06-4771-bcd9-6eea315de162

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}