Skip to content

docs(agents): custom LLM endpoints take per-agent request headers (FA-525) - #284

Merged
Him188 merged 3 commits into
mainfrom
cale/fa-525-custom-llm-headers-docs
Oct 24, 2026
Merged

Him188 merged 3 commits into
mainfrom
cale/fa-525-custom-llm-headers-docs

Conversation

@cshape

@cshape cshape commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

What

Documents llm.custom.headers on the Custom LLM page: extra headers sent on every request to the customer's endpoint.

  • The auth paragraph points to headers for endpoints that need more than the bearer.
  • The PATCH example includes a headers object.
  • A headers row in the field table: write-only like api_key, sending it replaces the stored set, omit or null keeps it, {} clears it, and headers the platform sends itself can't be set.
  • A note that the console doesn't show or edit headers, keeps them on save, and Run test sends them for the saved endpoint.
  • versions-publishing.mdx lists headers with api_key as read back as null.

Merge after

  • The API serves the field: https://api.fish.audio/openapi.json lists headers on PublicAgentLLMCustomConfig. Until then the PATCH example returns 422.
  • The OpenAPI schema is updated: merge the nightly "chore: update OpenAPI schema" PR first, or run npm run update:openapi on this branch. The PR check fails while the committed schema differs from the live one.

Checks

  • The PATCH-with-headers example was tested end to end before release.
  • mint broken-links --check-anchors: no new broken links; the in-page anchor resolves.

@mintlify

mintlify Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
hanabiaiinc 🟢 Ready View Preview Oct 24, 2026, 6:04 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

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

@Him188
Him188 marked this pull request as ready for review October 24, 2026 08:02
@Him188
Him188 enabled auto-merge (squash) October 24, 2026 08:02
@Him188
Him188 merged commit daac37a into main Oct 24, 2026
5 of 6 checks passed
@Him188
Him188 deleted the cale/fa-525-custom-llm-headers-docs branch October 24, 2026 08:02

This branch was successfully deployed

1 active deployment
staging — a6c4d440 Deployed Oct 24, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants