Skip to content

docs: document API schema selection for custom inference endpoints - #438

Draft
hongyi-chen wants to merge 1 commit into
mainfrom
docs/custom-endpoint-api-schemas
Draft

docs: document API schema selection for custom inference endpoints#438
hongyi-chen wants to merge 1 commit into
mainfrom
docs/custom-endpoint-api-schemas

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

Custom inference endpoints now let you choose the request/response protocol your endpoint speaks. The docs still claimed the endpoint had to implement OpenAI Chat Completions, which is no longer accurate.

Found by the missing_docs drift-watch audit (changelog item #13938) and verified against CustomEndpointSchema in crates/ai/src/api_keys.rs and the schema dropdown in app/src/settings_view/custom_inference_modal.rs. The dropdown is not feature-flagged, so the capability is GA.

Changes

src/content/docs/agent-platform/inference/custom-inference-endpoint.mdx

  • Added an API schemas section documenting the three supported protocols: OpenAI Chat Completions (default), OpenAI Responses, and Anthropic Messages.
  • Rewrote the frontmatter description, opening paragraph, and "OpenAI-compatible" key feature, which all asserted Chat Completions was the only option.
  • Reworked How it works to reference the new section instead of restating a single required protocol.
  • Expanded Enabling a custom inference endpoint to cover the fields the modal actually asks for, in order: API schema, Endpoint name, Endpoint URL, API key, then model names and aliases.
  • Updated the BYOK/BYOLLM comparison table row.

src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx

  • Updated the two cross-references that described custom endpoints as OpenAI-compatible only.

Verification

  • npm run build passes.
  • Internal link check passes (0 broken links).
  • Re-ran the missing_docs audit: no new findings.

Deferred findings from this audit run

None specific to this page. Run-wide deferrals are listed in the companion audit-bookkeeping PR.

Conversation: https://staging.warp.dev/conversation/53c4f3f8-39bb-46c1-a5c0-66b467db0439
Run: https://oz.staging.warp.dev/runs/019fb91e-74a0-73f4-ac72-f2d88c32fab5

This PR was generated with Oz.

Co-Authored-By: Oz oz-agent@warp.dev

Custom endpoints now support OpenAI Chat Completions, OpenAI Responses,
and Anthropic Messages, selected per endpoint. The page still said an
endpoint had to implement Chat Completions.

Verified against CustomEndpointSchema in crates/ai/src/api_keys.rs and
the unflagged schema dropdown in app/src/settings_view/custom_inference_modal.rs.

Co-Authored-By: Oz <oz-agent@warp.dev>
@vercel

vercel Bot commented Jul 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Jul 31, 2026 5:36pm

Request Review

@hongyi-chen

hongyi-chen commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator Author

@szgupta is this correct? my agent discovered this change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants