Skip to content

docs: document selectable custom inference endpoint API formats - #457

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

docs: document selectable custom inference endpoint API formats#457
hongyi-chen wants to merge 1 commit into
mainfrom
docs/custom-endpoint-api-formats

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

What

Updates agents/inference/custom-inference-endpoint.mdx for the API-format selector: adds a
Supported API formats section, a configuration step for choosing the format, and reworks the
frontmatter, key features, and comparison table that all claimed OpenAI Chat Completions was the
only supported surface.

Why

Flagged by the missing_docs changelog cross-check (2026.07.31: "Custom model endpoints can now
select an OpenAI Chat Completions, OpenAI Responses, or Anthropic Messages ..."). The changelog
mention was the only coverage.

Source of truth

  • crates/ai/src/api_keys.rsCustomEndpointSchema (OpenaiChatCompletions as the default,
    OpenaiResponses, AnthropicMessages) and its display names.
  • app/src/settings_view/custom_inference_modal.rs — the schema dropdown in the endpoint modal.
  • app/src/settings_view/ai_page.rs — the settings copy listing the three formats.

Deferred findings from this run

Nothing from the audit was silently dropped. The full deferral list lives in the companion
bookkeeping PR (docs/missing-docs-audit-bookkeeping); in summary:

  • 15 warp-server public API routes missing from the OpenAPI spec — routed to the
    sync-openapi-spec skill rather than hand-written, per the skill's public/private guardrail.
  • 32 terminology/staleness findings — owned by the style_lint skill.
  • 1 new server-side agent tool (report_external_reference) — reached only through the hidden
    oz harness-support CLI, so no public surface to document yet.

Conversation: https://staging.warp.dev/conversation/c45bb2ea-d33b-4723-8249-478547f81a47
Run: https://oz.staging.warp.dev/runs/019fc891-7c04-779b-b006-328169d8a0d7

This PR was generated with Oz.

Custom endpoints now declare which request format they speak: OpenAI Chat
Completions, OpenAI Responses, or Anthropic Messages. The page previously
described OpenAI Chat Completions as the only supported surface.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Aug 3, 2026
@vercel

vercel Bot commented Aug 3, 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 Aug 3, 2026 5:21pm

Request Review

Copy link
Copy Markdown
Collaborator Author

Heads-up on overlap: #438 also documents the custom inference endpoint API schema selector, but both of its files are under src/content/docs/agent-platform/inference/, a path that no longer exists after the agent-platform/agents/ rename in #420. This PR targets the current path. #438 additionally touches bring-your-own-api-key.mdx, which this PR does not — worth checking whether that part is still needed before closing either one.

Copy link
Copy Markdown
Collaborator Author

Reviewer routing: scripts/suggest_reviewers.py resolves the source file behind this change to the @warpdotdev/oss-maintainers team (matched via the root / rule in the warp repo's .github/STAKEHOLDERS). Requesting that team as a reviewer didn't take through the API from this run, so it needs assigning manually.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant