API Changelog

​

Actionable model availability errors

• New error.availability object with fields: code (one of 11 stable values: model_not_found, wrong_endpoint, no_endpoints, model_deprecated, model_unavailable_upstream, capacity_exhausted, temporarily_unavailable, region_restricted, privacy_restricted, constraint_filtered, free_variant_ended), retryable, retry_after, requested_models, affected_providers, excluded_by, fallback_models, constraint, and docs_url. See Model availability errors for the full code table, field reference, and example payloads.
• Migration notes: The change is additive and backward compatible — error_type, http_status, and message are unchanged, so existing error handling keeps working. Clients that currently parse the free-text message prose to distinguish availability conditions should switch to availability.code. Clients keying off HTTP status alone should note that unknown model ids on the chat completions router now consistently return 400 (previously they could surface as 500). availability.retry_after mirrors the Retry-After header in the response body and is populated whenever any attempted endpoint supplied a retry hint. error.metadata.previous_errors is now a slim, stable shape ({provider, code, status}) and no longer carries raw upstream provider error bodies — do not parse upstream bodies from it.

​

Modified endpoints

• GET /benchmarks: description updated; parameter source updated; response schema updated

​

New schemas

• UnifiedBenchmarksORItem
  • Used by GET /benchmarks

​

Modified schemas

• UnifiedBenchmarksMeta: enum property_added
  • Used by GET /benchmarks
• UnifiedBenchmarksResponse: example modified; new union variant added
  • Used by GET /benchmarks

​

Breaking changes

• FusionCallAnalysisInProgressEvent: required analyst_model property addedNo action needed
  • No action required for existing consumers. analyst_model replaces judge_model in this streaming event; judge_model is retained as a deprecated alias that always carries the same value.
  • Used by POST /responses
• $.tags: responses object removedNo action needed
  • No action required. The responses OpenAPI tag was renamed to Responses for consistent Title Case across the API Reference. This is a documentation-grouping change only: POST /api/v1/responses and its schemas are unchanged, SDK namespaces are unchanged (client.responses.send() in TypeScript and Python, Sdk.Responses.Send() in Go), and endpoint documentation URLs are unchanged.

​

Modified endpoints

• GET /files: parameter cursor updated; response schema updated
• POST /files: response schema updated
• DELETE /files/{file_id}: parameter file_id updated; response schema updated
• GET /files/{file_id}: parameter file_id updated; response schema updated
• GET /files/{file_id}/content: parameter file_id updated

​

Modified schemas

• FusionAnalysisResult: description updated
  • Used by POST /presets/{slug}/responses, POST /responses
• FusionCallAnalysisCompletedEvent: description updated
  • Used by POST /responses
• FusionCallAnalysisInProgressEvent:
  • description updated
  • example modified
  • new property analyst_model
  • property judge_model deprecated (alias of analyst_model, kept for existing consumers)
  • Used by POST /responses
• FusionPlugin: description updated

  Show 6 endpoints using this schema

  • POST /chat/completions
  • POST /messages
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/messages
  • POST /presets/{slug}/responses
  • POST /responses
• FusionServerToolConfig: description updated; property effort updated; property max_tokens updated

  Show 4 endpoints using this schema

  • POST /chat/completions
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/responses
  • POST /responses
• FusionServerTool_OpenRouter: description updated

  Show 4 endpoints using this schema

  • POST /chat/completions
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/responses
  • POST /responses
• FusionSource: description updated
  • Used by POST /presets/{slug}/responses, POST /responses
• OutputFusionServerToolItem: description updated
  • Used by POST /presets/{slug}/responses, POST /responses
• ChatWebSearchShorthand: description updated
  • Used by POST /chat/completions, POST /presets/{slug}/chat/completions
• WebSearchConfig: description updated

  Show 4 endpoints using this schema

  • POST /chat/completions
  • POST /messages
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/messages
• WebSearchDomainFilter: example modified; new property blocked_domains
  • Used by POST /presets/{slug}/responses, POST /responses
• WebSearchServerToolConfig: description updated
  • Used by POST /presets/{slug}/responses, POST /responses
• AnthropicFileDocumentSource: example modified
  • Used by POST /messages, POST /presets/{slug}/messages
• FileDeleteResponse: example modified
  • Used by DELETE /files/{file_id}
• FileListResponse: example modified
  • Used by GET /files
• FileMetadata: example modified
  • Used by GET /files, GET /files/{file_id}, POST /files
• GenerationResponse: property data_region updated
  • Used by GET /generation
• CreateGuardrailRequest: new property enable_free_model_publication; new property enable_free_model_training; new property enable_paid_model_training
  • Used by POST /guardrails
• Guardrail:
  • example modified
  • new property enable_free_model_publication
  • new property enable_free_model_training
  • new property enable_paid_model_training

  Show 4 endpoints using this schema

  • GET /guardrails
  • GET /guardrails/{id}
  • PATCH /guardrails/{id}
  • POST /guardrails
• UpdateGuardrailRequest: new property enable_free_model_publication; new property enable_free_model_training; new property enable_paid_model_training
  • Used by PATCH /guardrails/{id}
• AutoBetaRouterPlugin:
  • example modified
  • new property cost_tier
  • deprecated property_added
  • description updated

  Show 6 endpoints using this schema

  • POST /chat/completions
  • POST /messages
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/messages
  • POST /presets/{slug}/responses
  • POST /responses
• AutoRouterPlugin:
  • example modified
  • new property cost_tier
  • deprecated property_added
  • description updated

  Show 6 endpoints using this schema

  • POST /chat/completions
  • POST /messages
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/messages
  • POST /presets/{slug}/responses
  • POST /responses

​

Modified endpoints

• POST /embeddings: request schema updated

​

Modified schemas

• Quantization: enum property_added

  Show 10 endpoints using this schema

  • GET /endpoints/zdr
  • GET /models/{author}/{slug}/endpoints
  • POST /chat/completions
  • POST /embeddings
  • POST /messages
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/messages
  • POST /presets/{slug}/responses
  • POST /rerank
  • POST /responses
• ReasoningFormat: enum property_added

  Show 4 endpoints using this schema

  • POST /chat/completions
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/responses
  • POST /responses

​

Breaking changes

• POST /responses: tags beta.responses property removed
  • Migration: no action for HTTP clients. The Responses API is now GA. beta.responses was an OpenAPI grouping tag and SDK namespace, never a URL. POST /api/v1/responses and its request and response schemas are unchanged, so raw HTTP callers and OpenAI-compatible clients (including the OpenAI Agents SDK) need no changes. The endpoint now appears under Responses instead of Beta responses in the API Reference.
  • Migration for SDK users: optional until sunset. The canonical namespace is now responses, with client.responses.send() (TypeScript, Python) and client.Responses.Send() (Go). The beta.responses namespace, and TypeScript’s betaResponsesSend standalone function, keep working as deprecated aliases; their removal will be announced here with a sunset date before it ships.
• $.tags: beta.responses object removed
  • Same change as above at the specification level: the beta.responses tag definition is gone from $.tags.

​

Modified endpoints

• POST /responses: tags property_added
• GET /byok: parameter provider updated

​

Modified schemas

• MessagesStartEvent: property provider updated
  • Used by POST /messages
• ProviderName: enum property_added

  Show 11 endpoints using this schema

  • GET /endpoints/zdr
  • GET /models/{author}/{slug}/endpoints
  • POST /chat/completions
  • POST /embeddings
  • POST /images
  • POST /messages
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/messages
  • POST /presets/{slug}/responses
  • POST /rerank
  • POST /responses
• ProviderOptions: new property claude-on-aws

  Show 4 endpoints using this schema

  • POST /audio/speech
  • POST /audio/transcriptions
  • POST /images
  • POST /videos
• ProviderResponse: enum property_added
  • Used by GET /generation
• BYOKProviderSlug: enum property_added

  Show 4 endpoints using this schema

  • GET /byok
  • GET /byok/{id}
  • PATCH /byok/{id}
  • POST /byok

​

Modified schemas

• MessagesStartEvent: property provider updated
  • Used by POST /messages
• ProviderName: enum property_added

  Show 11 endpoints using this schema

  • GET /endpoints/zdr
  • GET /models/{author}/{slug}/endpoints
  • POST /chat/completions
  • POST /embeddings
  • POST /images
  • POST /messages
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/messages
  • POST /presets/{slug}/responses
  • POST /rerank
  • POST /responses
• ProviderOptions: new property voyageai

  Show 4 endpoints using this schema

  • POST /audio/speech
  • POST /audio/transcriptions
  • POST /images
  • POST /videos
• ProviderResponse: enum property_added
  • Used by GET /generation
• AnthropicCompactionBlock: new property encrypted_content
  • Used by POST /messages
• MessagesToolAdditionBlock: new property cache_control; new union variant added; type property_removed
  • tool widened from a single tool_reference object to a union of tool_reference, mcp_tool_reference (name + server_name) and mcp_toolset_reference (server_name). The tool_reference variant is unchanged, so existing { "type": "tool_reference", "name": "…" } payloads stay valid. The name and type properties moved into that variant rather than being removed.
  • Used by POST /messages, POST /presets/{slug}/messages
• MessagesToolRemovalBlock: new property cache_control; new union variant added; type property_removed
  • tool widened the same way as MessagesToolAdditionBlock; existing tool_reference payloads stay valid.
  • Used by POST /messages, POST /presets/{slug}/messages
• ORAnthropicStopReason: enum property_added
  • Used by POST /messages

​

New schemas

• ImageGenTextChunkEvent
  • Used by POST /images

​

Modified schemas

• ImageStreamingResponse: new union variant added
  • Used by POST /images

​

Modified endpoints

• POST /audio/transcriptions: description updated; request body now accepts multipart/form-data
• GET /datasets/rankings-daily:
  • description updated
  • new parameter category
  • new parameter context_bucket
  • new parameter language_type
  • new parameter modality
  • new parameter period
• GET /models:
  • new parameter max_age_days
  • new parameter max_agentic_index
  • new parameter max_coding_index
  • new parameter max_intelligence_index
  • new parameter max_output_price
  • new parameter max_tool_success_rate
  • new parameter min_age_days
  • new parameter min_agentic_index
  • new parameter min_coding_index
  • new parameter min_intelligence_index
  • new parameter min_output_price
  • new parameter min_tool_success_rate
  • description updated
  • parameter sort updated

​

New response codes

• POST /images: now returns 413

​

New schemas

• STTSegment
  • Used by POST /audio/transcriptions
• STTTimestampGranularity
  • Used by POST /audio/transcriptions
• STTWord
  • Used by POST /audio/transcriptions

​

Modified schemas

• ChatFunctionTool: new union variant added
  • Used by POST /chat/completions, POST /presets/{slug}/chat/completions
• FusionServerToolConfig: description updated

  Show 4 endpoints using this schema

  • POST /chat/completions
  • POST /presets/{slug}/chat/completions
  • POST /presets/{slug}/responses
  • POST /responses
• ImageGenCompletedEvent: description updated; example modified
  • Used by POST /images
• ImageGenerationResponse: property media_type updated
  • Used by POST /images
• STTRequest: new property response_format; new property timestamp_granularities
  • Used by POST /audio/transcriptions
• STTResponse:
  • new property duration
  • new property language
  • new property segments
  • new property task
  • new property words
  • Used by POST /audio/transcriptions

​

New endpoints

• GET /workspaces/{id}/members: List workspace members

​

New schemas

• ListWorkspaceMembersResponse
  • Used by GET /workspaces/{id}/members