https://openrouter.ai/api/v1).
API KeysBreakingEnd UsersGuardrailsInternsSchemas
Breaking changes
-
CreateEndUserRequest: maxLength256modifiedNo action needed- No action required for existing consumers. The maximum end-user ID length increased from 256 to 512 characters.
- Used by
POST /end-users
-
CreateEndUserRequest: pattern^[^\p{Cc}]+$modifiedNo action needed- No action required for existing consumers. The pattern now permits control characters other than NUL.
- Used by
POST /end-users
-
EndUser: maxLength256modifiedNo action needed -
EndUser: pattern^[^\p{Cc}]+$modifiedNo action needed -
GET /end-users: maxLength256modifiedNo action needed -
GET /end-users: pattern^[^\p{Cc}]+$modifiedNo action needed -
DELETE /end-users/{user}: maxLength256modifiedNo action needed -
DELETE /end-users/{user}: pattern^[^\p{Cc}]+$modifiedNo action needed -
GET /end-users/{user}: maxLength256modifiedNo action needed -
GET /end-users/{user}: pattern^[^\p{Cc}]+$modifiedNo action needed -
PATCH /end-users/{user}: maxLength256modifiedNo action needed -
PATCH /end-users/{user}: pattern^[^\p{Cc}]+$modifiedNo action needed
Modified endpoints
GET /end-users: description updatedDELETE /end-users/{user}: description updatedGET /end-users/{user}: description updatedPATCH /end-users/{user}: description updatedPATCH /keys/{hash}: description updated; request schema updatedPOST /guardrails: description updatedPATCH /guardrails/{id}: description updatedPOST /guardrails/{id}/assignments/keys: description updatedPOST /interns: description updatedPATCH /keys/{hash}: description updated
New response codes
PATCH /keys/{hash}: now returns403PATCH /keys/{hash}: now returns409
Modified schemas
-
CreateEndUserRequest: description updated- Used by
POST /end-users
- Used by
-
EndUser: description updated -
AlignmentPlugin: description updated
API KeysInternsSchemas
Modified endpoints
GET /keys: new parameterinclude_expiredPOST /interns: description updated; response schema updated
Modified schemas
-
PublicEndpoint: description updated -
JevRouterPlugin: new propertycost_tier -
BulkAssignKeysRequest: maxItems property_added -
BulkUnassignKeysRequest: maxItems property_added
InternsSchemas
New endpoints
POST /interns/{internId}/daemon-access/sign: Sign a daemon request with the caller’s identity (deprecated alias)POST /interns/{internId}/daemon/sign: Sign a daemon request with the caller’s identity
New schemas
ToolSearchCallItemToolSearchOutputItemSignInternDaemonRequestSignInternDaemonResponseOutputToolSearchCallItem- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
Modified schemas
-
OutputApplyPatchServerToolItem: new propertyerror; $ref modified -
OutputDatetimeItem: new propertyerror; $ref modified -
OutputImageGenerationServerToolItem: new propertyerror; $ref modified -
OutputSearchModelsServerToolItem: new propertyerror; $ref modified -
OutputToolSearchServerToolItem: new propertyerror; $ref modified -
OutputWebSearchServerToolItem: new propertyerror; $ref modified -
SwitchyardRouterPlugin: description updated -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderResponse: x-speakeasy-unknown-values object_added- Used by
GET /generation
- Used by
-
OutputItems: new union variant added- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
API KeysBYOKBreakingSchemas
Breaking changes
-
BYOKKey: requireddeclared_regionproperty addedNo action needed- No action required for existing consumers. Responses from BYOK endpoints now include
declared_region("global","europe","us", ornull) indicating the key’s declared data region.
- No action required for existing consumers. Responses from BYOK endpoints now include
-
GET /keys: requiredlast_used_atproperty addedNo action needed- No action required for existing consumers. API key responses now include
last_used_at, an ISO 8601 UTC timestamp of the key’s most recent recorded usage, ornullif none has been recorded.
- No action required for existing consumers. API key responses now include
-
POST /keys: requiredlast_used_atproperty addedNo action needed -
GET /keys/{hash}: requiredlast_used_atproperty addedNo action needed -
PATCH /keys/{hash}: requiredlast_used_atproperty addedNo action needed
Modified endpoints
GET /byok: response schema updatedPOST /byok: response schema updatedGET /byok/{id}: response schema updatedPATCH /byok/{id}: response schema updatedGET /keys: response schema updatedPOST /keys: response schema updatedGET /keys/{hash}: response schema updatedPATCH /keys/{hash}: response schema updated
New response codes
PATCH /byok/{id}: now returns409
New schemas
SpeechInput- Used by
POST /audio/speech
- Used by
SpeechTurn- Used by
POST /audio/speech
- Used by
Modified schemas
-
BYOKKey: example modified; new propertydeclared_region -
CreateBYOKKeyRequest: new propertydeclared_region- Used by
POST /byok
- Used by
-
CreateBYOKKeyResponse: example modified- Used by
POST /byok
- Used by
-
GetBYOKKeyResponse: example modified- Used by
GET /byok/{id}
- Used by
-
ListBYOKKeysResponse: example modified- Used by
GET /byok
- Used by
-
UpdateBYOKKeyRequest: new propertydeclared_region- Used by
PATCH /byok/{id}
- Used by
-
UpdateBYOKKeyResponse: example modified- Used by
PATCH /byok/{id}
- Used by
-
SwitchyardRouterPlugin: new propertyjudge_model -
SpeechRequest: new propertyinstructions; $ref modified- Used by
POST /audio/speech
- Used by
Schemas
Modified schemas
BatchProviderPreferences: description updated; new propertyallow_fallbacks- Used by
POST /batches
- Used by
BreakingSTTSchemas
Breaking changes
Modified endpoints
POST /audio/transcriptions: description updated
Modified schemas
-
ObservabilityClickhouseDestination: new propertyshouldIncludeCacheWriteTokens -
ObservabilitySnowflakeDestination: new propertyshouldIncludeCacheWriteTokens -
STTRequest: description updated; new propertydata_collection; new propertyzdr- Used by
POST /audio/transcriptions
- Used by
-
SpeechRequest: description updated; new propertydata_collection; new propertyzdr- Used by
POST /audio/speech
- Used by
API KeysAnalyticsBreakingGenerationsSchemas
Breaking changes
ActivityItem: requiredcached_tokensproperty addedNo action needed- Used by
GET /activity
- Used by
Modified endpoints
GET /generation: parameteridupdatedGET /generation/content: parameteridupdatedGET /activity: response schema updatedPATCH /keys/{hash}: description updated; response schema updated
New response codes
GET /generation: now returns400GET /generation/content: now returns400
New schemas
ChatDynamicServerTool
Modified schemas
ChatFunctionTool: new union variant addedActivityItem: example modified; new propertycached_tokens- Used by
GET /activity
- Used by
ActivityResponse: example modified- Used by
GET /activity
- Used by
ImageGenerationRequest: enum property_added- Used by
POST /images
- Used by
ContainersEnd UsersOrganizationSchemas
New endpoints
GET /end-users: List registered end usersPOST /end-users: Register an end userGET /end-users/{user}: Get a registered end userPATCH /end-users/{user}: Update a registered end userDELETE /end-users/{user}: Deactivate a registered end userGET /organization/settings: Get organization settingsPATCH /organization/settings: Update organization settings
Modified endpoints
GET /containers/{container_id}/files: description updated
New schemas
-
Alignment- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentAllowedCallRecord- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentBlockedCallRecord- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentCallRecord- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentChatAudio- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentChatImage- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentChatRejected- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentChatToolCall- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentPlugin -
AlignmentRejected- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentResponsesRejected- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentRuleRecord- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
AlignmentUnavailableCallRecord- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
OpenResponsesErrorField- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
OpenResponsesErrorMetadata- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
CreateEndUserRequest- Used by
POST /end-users
- Used by
-
EndUser -
EndUserResponse -
ListEndUsersResponse- Used by
GET /end-users
- Used by
-
UpdateEndUserRequest- Used by
PATCH /end-users/{user}
- Used by
-
OrganizationSettings -
UpdateOrganizationSettingsRequest- Used by
PATCH /organization/settings
- Used by
Modified schemas
-
ChatRequest: new union variant added -
MessagesRequest: new union variant added -
ResponsesRequest: new union variant added -
SwitchyardRouterPlugin: description updated
BYOKBatchBreakingInternsSTTSchemasToolsVault
Breaking changes
-
JevRouterPlugin: additionalPropertiesfalseobject addedNo action needed -
STTInputAudio: propertiesdataobject removedNo action needed- Used by
POST /audio/transcriptions
- Used by
-
STTInputAudio: propertiesformatobject removedNo action needed- Used by
POST /audio/transcriptions
- Used by
-
STTInputAudio: requireddataproperty removedNo action needed- Used by
POST /audio/transcriptions
- Used by
-
STTInputAudio: requiredformatproperty removedNo action needed- Used by
POST /audio/transcriptions
- Used by
-
POST /audio/transcriptions: requiredfileproperty removedNo action needed
New endpoints
GET /vault/interns/{internId}/effective-secrets: List the secrets an intern receivesGET /tools: List server toolsGET /tools/{name}: Get a server tool
Modified endpoints
GET /interns: description updatedPOST /interns: description updatedDELETE /interns/{internId}: description updatedGET /interns/{internId}: description updatedPATCH /interns/{internId}: description updatedGET /interns/{internId}/daemon: description updatedGET /interns/{internId}/daemon-access: description updatedPOST /interns/{internId}/provision: description updatedPOST /interns/{internId}/suspend: description updatedGET /vault/interns/{internId}/secrets: description updatedPOST /vault/interns/{internId}/secrets/copy: description updatedDELETE /vault/interns/{internId}/secrets/{name}: description updatedPUT /vault/interns/{internId}/secrets/{name}: description updatedGET /vault/secrets: description updatedDELETE /vault/secrets/{name}: description updatedPUT /vault/secrets/{name}: description updatedPOST /audio/transcriptions: description updated; request schema updatedGET /byok: parameterproviderupdated
New response codes
GET /batches/{id}: now returns410
New schemas
-
VaultEffectiveSecret -
VaultEffectiveSecretListResponse -
JevRouterPlugin -
STTEntity- Used by
POST /audio/transcriptions
- Used by
-
STTInlineInputAudio- Used by
POST /audio/transcriptions
- Used by
-
STTUrlInputAudio- Used by
POST /audio/transcriptions
- Used by
-
GetToolResponse- Used by
GET /tools/{name}
- Used by
-
ListToolsResponse- Used by
GET /tools
- Used by
-
ServerTool- Used by
GET /tools,GET /tools/{name}
- Used by
-
ServerToolDetails- Used by
GET /tools/{name}
- Used by
-
ServerToolEngine- Used by
GET /tools,GET /tools/{name}
- Used by
-
ServerToolExecutedBy- Used by
GET /tools,GET /tools/{name}
- Used by
-
ServerToolInputName- Used by
GET /tools,GET /tools/{name}
- Used by
-
ServerToolNativeModel- Used by
GET /tools/{name}
- Used by
-
ServerToolNativeSupport- Used by
GET /tools,GET /tools/{name}
- Used by
-
ServerToolOutputName- Used by
GET /tools,GET /tools/{name}
- Used by
-
ServerToolPrice- Used by
GET /tools,GET /tools/{name}
- Used by
Modified schemas
-
OutputFusionServerToolItem: description updated -
ChatRequest: new union variant added -
MessagesRequest: new union variant added -
ResponsesRequest: new union variant added -
JevRouterPlugin: new propertyallowed_models; description updated -
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertyelevenlabs -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
-
STTInputAudio:- new union variant added
- description updated
- example property_removed
- type property_removed
- Used by
POST /audio/transcriptions
-
STTRequest: description updated; new propertydiarize; new propertykeyterms- Used by
POST /audio/transcriptions
- Used by
-
STTResponse: new propertyentities; new propertylanguage_confidence- Used by
POST /audio/transcriptions
- Used by
-
STTSegment: new propertychannel; new propertyspeaker_label- Used by
POST /audio/transcriptions
- Used by
-
STTWord:- new property
channel - new property
speaker_label - new property
type - description updated
- Used by
POST /audio/transcriptions
- new property
-
ChatRequest: description updated; enum property_added -
ResponsesRequest: description updated; enum property_added -
ServiceTier: enum property_added- Used by
GET /batches/{id},POST /batches,POST /responses
- Used by
-
SpeechRequest: description updated- Used by
POST /audio/speech
- Used by
BreakingEndpointsInternsPrivate EndpointsSchemas
Breaking changes
PublicEndpoint: requirednative_toolsproperty addedNo action needed
New endpoints
GET /interns/{internId}/daemon: Get an intern’s daemon accessGET /private-endpoints: List private endpointsPOST /private-endpoints: Create a private endpointGET /private-endpoints/{id}: Get a private endpointPATCH /private-endpoints/{id}: Update a draft private endpointDELETE /private-endpoints/{id}: Delete a private endpointPOST /private-endpoints/{id}/activate: Activate a validated private endpointPOST /private-endpoints/{id}/disable: Disable a private endpointPOST /private-endpoints/{id}/enable: Enable a private endpointPUT /private-endpoints/{id}/pricing: Set private endpoint pricingPOST /private-endpoints/{id}/validate: Validate a draft private endpoint
Modified endpoints
GET /endpoints/zdr: response schema updatedGET /models/{author}/{slug}/endpoints: response schema updatedGET /interns/{internId}/daemon-access: deprecated property_added; description updated
New schemas
-
CreatePrivateEndpointRequest- Used by
POST /private-endpoints
- Used by
-
CreatePrivateEndpointValidationFailedResponse- Used by
POST /private-endpoints
- Used by
-
DeletePrivateEndpointResponse- Used by
DELETE /private-endpoints/{id}
- Used by
-
ListPrivateEndpointsResponse- Used by
GET /private-endpoints
- Used by
-
ManagedPrivateEndpoint -
ManagedPrivateEndpointResponse -
PrivateEndpoint -
PrivateEndpointActivation- Used by
POST /private-endpoints
- Used by
-
PrivateEndpointCheck -
PrivateEndpointCheckReason -
PrivateEndpointDeclaredRegion -
PrivateEndpointPricing -
PrivateEndpointResponse -
PrivateEndpointStatus -
PrivateEndpointSummary -
PrivateEndpointValidation -
PrivateEndpointValidationNullable- Used by
POST /private-endpoints
- Used by
-
PrivateEndpointValidationResponse -
UpdatePrivateEndpointPricingRequest -
UpdatePrivateEndpointRequest- Used by
PATCH /private-endpoints/{id}
- Used by
-
ValidatePrivateEndpointRequest
Modified schemas
AnthropicWebFetchToolResultError: enum property_added- Used by
GET /batches/{id},POST /batches,POST /messages
- Used by
PublicEndpoint: example modified; new propertynative_toolsMessagesRequest: new union variant added
Embeddings
New response codes
POST /embeddings: now returns504
BYOKBatchBreakingEndpointsInternsSchemasTTS
Breaking changes
GET /interns/{internId}/daemon-access: codes429object removedNo action neededSpeechInputReferenceAudioInput: requireddataproperty removedNo action needed- Used by
POST /audio/speech
- Used by
New endpoints
GET /batches: List batchesPOST /batches: Create a batchGET /batches/{id}: Get a batchDELETE /batches/{id}: Delete a batch
Modified endpoints
GET /interns/{internId}/daemon-access: description updatedPOST /audio/speech: description updatedGET /endpoints/zdr: response schema updatedGET /byok: parameterproviderupdated
New schemas
-
SpeechInputReferenceImage- Used by
POST /audio/speech
- Used by
-
SpeechInputReferenceImageInput- Used by
POST /audio/speech
- Used by
-
BatchDeletedObject- Used by
DELETE /batches/{id}
- Used by
-
BatchDeletionOutcome- Used by
DELETE /batches/{id}
- Used by
-
BatchDeletionTargets- Used by
DELETE /batches/{id}
- Used by
-
BatchErrorResponse -
BatchListItem- Used by
GET /batches
- Used by
-
BatchListResponse- Used by
GET /batches
- Used by
-
BatchListStatus- Used by
GET /batches
- Used by
-
BatchListTimestamp- Used by
GET /batches
- Used by
-
BatchObject- Used by
GET /batches/{id},POST /batches
- Used by
-
BatchPaymentRequiredResponse- Used by
GET /batches/{id}
- Used by
-
BatchProviderPreferences- Used by
POST /batches
- Used by
-
BatchSubmitBody- Used by
POST /batches
- Used by
-
FinishReason- Used by
GET /batches/{id},POST /batches
- Used by
Modified schemas
-
PublicEndpoint: example modified; new propertysupports_image_reference; new propertysupports_multiple_audio_references -
SpeechInputReference: description updated; new union variant added- Used by
POST /audio/speech
- Used by
-
SpeechInputReferenceAudio: description updated- Used by
POST /audio/speech
- Used by
-
SpeechInputReferenceAudioInput: new propertyurl; description updated- Used by
POST /audio/speech
- Used by
-
SpeechInputReferenceText: description updated- Used by
POST /audio/speech
- Used by
-
SpeechRequest: description updated- Used by
POST /audio/speech
- Used by
-
ImageGenerationRequest: enum property_added- Used by
POST /images
- Used by
-
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertyrespan -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
BYOKInternsSCIMSchemas
New endpoints
GET /interns/{internId}/daemon-access: Get an intern’s daemon access
Modified endpoints
GET /scim/groups: new parameterdisplay_name; new parameterexternal_idGET /byok: parameterproviderupdated
New schemas
InternDaemonAccess
Modified schemas
-
ProviderPreferences: new propertyoptions -
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertyscaledown -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
BreakingInternsSchemas
Breaking changes
- spec: arguments property addedNo action needed
- spec: call_id property addedNo action needed
- spec: input property addedNo action needed
- spec: name property addedNo action needed
- spec: type property addedNo action needed
- $.components: allOf object removedNo action needed
- $.components: anyOf object removedNo action needed
CustomToolCallItem: allOfallOfobject removedNo action neededCustomToolCallItem: requiredcall_idproperty addedNo action neededCustomToolCallItem: requiredinputproperty addedNo action neededCustomToolCallItem: requirednameproperty addedNo action neededCustomToolCallItem: requiredtypeproperty addedNo action neededFunctionCallItem: allOfallOfobject removedNo action neededFunctionCallItem: requiredargumentsproperty addedNo action neededFunctionCallItem: requiredcall_idproperty addedNo action neededFunctionCallItem: requirednameproperty addedNo action neededFunctionCallItem: requiredtypeproperty addedNo action needed
New endpoints
POST /interns/{internId}/invoke: Start an intern run without waiting for it
New schemas
InternInvokeAcceptedResponse- Used by
POST /interns/{internId}/invoke
- Used by
InternInvokeRequest- Used by
POST /interns/{internId}/invoke
- Used by
Modified schemas
CustomToolCallItem:- new property
async - new property
call_id - new property
id - new property
input - new property
name - new property
namespace - new property
status - new property
type - type property_added
- Used by
POST /presets/{slug}/responses,POST /responses
- new property
FunctionCallItem:- new property
arguments - new property
async - new property
call_id - new property
id - new property
name - new property
namespace - new property
status - new property
subagent_id - new property
subagent_items - new property
type - type property_added
- Used by
POST /presets/{slug}/responses,POST /responses
- new property
InternsSchemasWorkspacesalpha.decisions
Modified endpoints
GET /workspaces: response schema updatedPOST /workspaces: response schema updatedGET /workspaces/{id}: response schema updatedPATCH /workspaces/{id}: response schema updatedPOST /api/alpha/decisions: description updatedPOST /interns/{internId}/chat/completions: description updatedDELETE /interns/{internId}: description updated; response schema updatedPOST /interns/{internId}/provision: description updated; response schema updatedPOST /interns/{internId}/suspend: description updated; response schema updated
New schemas
-
AnthropicSafeguard -
AnthropicSafeguardResult- Used by
POST /messages
- Used by
-
SwitchyardRouterPlugin
Modified schemas
-
CreateWorkspaceRequest: new propertydisabled_server_tools- Used by
POST /workspaces
- Used by
-
CreateWorkspaceResponse: example modified- Used by
POST /workspaces
- Used by
-
GetWorkspaceResponse: example modified- Used by
GET /workspaces/{id}
- Used by
-
ListWorkspacesResponse: example modified- Used by
GET /workspaces
- Used by
-
MessagesDeltaEvent: new propertysafeguard_results- Used by
POST /messages
- Used by
-
MessagesRequest: new propertysafeguards -
UpdateWorkspaceRequest: new propertydisabled_server_tools- Used by
PATCH /workspaces/{id}
- Used by
-
UpdateWorkspaceResponse: example modified- Used by
PATCH /workspaces/{id}
- Used by
-
Workspace: example modified; new propertydisabled_server_tools -
ResponsesRequest: description updated -
ChatRequest: new union variant added -
MessagesRequest: new union variant added -
ResponsesRequest: new union variant added
BYOKBreakingInternsSchemas
Breaking changes
-
InternChatErrorMetadata: requiredretryableproperty addedNo action needed -
BYOKKey: requireddeclared_zdrproperty addedNo action needed
Modified endpoints
GET /interns: description updated; parameterstatusupdated; response schema updatedPOST /interns: description updated; parameterIdempotency-Keyupdated; response schema updatedDELETE /interns/{internId}: response schema updated; description updatedGET /interns/{internId}: response schema updated; description updatedPATCH /interns/{internId}: response schema updated; description updatedPOST /interns/{internId}/chat/completions: response schema updated; description updatedPOST /interns/{internId}/provision: description updated; response schema updatedPOST /interns/{internId}/suspend: description updated; response schema updatedGET /byok: response schema updatedPOST /byok: response schema updatedGET /byok/{id}: response schema updatedPATCH /byok/{id}: response schema updatedPOST /interns/{internId}/chat/completions: description updatedPOST /interns: description updatedDELETE /interns/{internId}: description updatedPATCH /interns/{internId}: description updated
New response codes
PATCH /interns/{internId}: now returns409POST /interns/{internId}/chat/completions: now returns408POST /interns/{internId}/provision: now returns400POST /interns/{internId}/provision: now returns413POST /interns/{internId}/suspend: now returns400POST /interns/{internId}/suspend: now returns413POST /interns/{internId}/chat/completions: now returns202POST /interns: now returns415DELETE /interns/{internId}: now returns415PATCH /interns/{internId}: now returns415POST /interns/{internId}/provision: now returns415POST /interns/{internId}/suspend: now returns415
New schemas
-
XSearchOptions -
InternChatSteeredResponse
Modified schemas
-
InternChatError: example modified -
InternChatErrorMetadata: example modified; new propertyretryable -
InternChatErrorResponse: example modified -
InternChatStreamError: example modified -
InternLifecycleError: example modified; new propertymetadata -
VideoGenerationRequest: enum property_added- Used by
POST /videos
- Used by
-
VideoModel: enum property_added- Used by
GET /videos/models
- Used by
-
ChatWebSearchShorthand: new propertyx_search; description updated -
Legacy_WebSearchServerTool: new propertyx_search -
Preview_20250311_WebSearchServerTool: new propertyx_search -
Preview_WebSearchServerTool: new propertyx_search -
WebSearchConfig: new propertyx_search; description updated -
WebSearchPlugin: new propertyx_search -
WebSearchServerTool: new propertyx_search -
WebSearchServerToolConfig: new propertyx_search; description updated -
BYOKKey: example modified; new propertydeclared_zdr -
CreateBYOKKeyRequest: new propertydeclared_zdr- Used by
POST /byok
- Used by
-
CreateBYOKKeyResponse: example modified- Used by
POST /byok
- Used by
-
GetBYOKKeyResponse: example modified- Used by
GET /byok/{id}
- Used by
-
ListBYOKKeysResponse: example modified- Used by
GET /byok
- Used by
-
UpdateBYOKKeyRequest: new propertydeclared_zdr- Used by
PATCH /byok/{id}
- Used by
-
UpdateBYOKKeyResponse: example modified- Used by
PATCH /byok/{id}
- Used by
BreakingSystemOnealpha.decisions
Breaking changes
POST /systemone: x-speakeasy-ignoretrueobject removedNo action neededPOST /systemone: tagsalpha.decisionsproperty removedNo action needed
New endpoints
POST /systemone: Submit a System One request (TypeSafe SDK compatible alias)
Modified endpoints
POST /systemone: x-speakeasy-name-override object_added; description updated; tags property_added
API KeysBYOKBreakingInternsObservabilitySchemas
Breaking changes
GET /key: requiredorganization_idproperty addedNo action neededGET /key: requiredworkspace_idproperty addedNo action neededCreateInternRequest: requiredworkspace_idproperty removedNo action needed- Used by
POST /interns
- Used by
InternChatAssistantMessage: requiredcontentproperty removedNo action neededDELETE /interns/{internId}: requestBodyrequestBodyproperty addedAction required- Regenerated SDK clients: pass
{}when no acknowledgement is needed, or{ acknowledge_workspace_loss: true }when deleting the intern also requires acknowledging workspace loss. Raw HTTP clients may continue to omit the body.
- Regenerated SDK clients: pass
Modified endpoints
GET /key: response schema updatedPOST /interns: description updated; response schema updatedPOST /interns/{internId}/chat/completions: description updatedDELETE /interns/{internId}: description updatedGET /interns: new parameterstarting_afterPATCH /observability/destinations/{id}: description updated; response schema updated
New response codes
DELETE /interns/{internId}: now returns400DELETE /interns/{internId}: now returns413PATCH /byok/{id}: now returns403
New schemas
DeleteInternRequest- Used by
DELETE /interns/{internId}
- Used by
Modified schemas
InternChatCompletionRequest: description updatedCreateInternRequest: description updated- Used by
POST /interns
- Used by
TokenExchangeRequest: pattern property_added- Used by
POST /oauth/token
- Used by
InternChatCompletionChunk: description updatedUpdateInternRequest: description updated; minLength property_added; pattern property_added- Used by
PATCH /interns/{internId}
- Used by
InternListResponse: new propertynext_cursor- Used by
GET /interns
- Used by
BreakingInternsSchemasalpha.decisions
Breaking changes
-
POST /api/alpha/decisions: tagsDecisionsproperty removedNo action needed - $.tags: Decisions object removedNo action needed
-
Intern: propertiescreatedAtobject removedAction required- Update response parsing from
createdAttocreated_at.
- Update response parsing from
-
Intern: propertieslastFailureMessageobject removedAction required- Update response parsing from
lastFailureMessagetolast_failure_message.
- Update response parsing from
-
Intern: propertiesupdatedAtobject removedAction required- Update response parsing from
updatedAttoupdated_at.
- Update response parsing from
-
Intern: propertiesworkspaceIdobject removedAction required- Update response parsing from
workspaceIdtoworkspace_id.
- Update response parsing from
-
Intern: requiredcreated_atproperty addedNo action needed -
Intern: requiredlast_failure_messageproperty addedNo action needed -
Intern: requiredupdated_atproperty addedNo action needed -
Intern: requiredworkspace_idproperty addedNo action needed -
Intern: requiredcreatedAtproperty removedNo action needed -
Intern: requiredlastFailureMessageproperty removedNo action needed -
Intern: requiredupdatedAtproperty removedNo action needed -
Intern: requiredworkspaceIdproperty removedNo action needed -
Intern: propertiesstepLabelobject removedAction required- Update response parsing from
stepLabeltostep_label.
- Update response parsing from
-
Intern: propertiesstepNumberobject removedAction required- Update response parsing from
stepNumbertostep_number.
- Update response parsing from
-
Intern: propertiestotalStepsobject removedAction required- Update response parsing from
totalStepstototal_steps.
- Update response parsing from
-
Intern: requiredstep_labelproperty addedNo action needed -
Intern: requiredstep_numberproperty addedNo action needed -
Intern: requiredtotal_stepsproperty addedNo action needed -
Intern: requiredstepLabelproperty removedNo action needed -
Intern: requiredstepNumberproperty removedNo action needed -
Intern: requiredtotalStepsproperty removedNo action needed -
POST /interns: propertiescreatedAtobject removedAction required- Update response parsing from
createdAttocreated_at.
- Update response parsing from
-
POST /interns: propertieslastFailureMessageobject removedAction required- Update response parsing from
lastFailureMessagetolast_failure_message.
- Update response parsing from
-
POST /interns: propertiesupdatedAtobject removedAction required- Update response parsing from
updatedAttoupdated_at.
- Update response parsing from
-
POST /interns: propertiesworkspaceIdobject removedAction required- Update response parsing from
workspaceIdtoworkspace_id.
- Update response parsing from
-
POST /interns: requiredcreated_atproperty addedNo action needed -
POST /interns: requiredlast_failure_messageproperty addedNo action needed -
POST /interns: requiredupdated_atproperty addedNo action needed -
POST /interns: requiredworkspace_idproperty addedNo action needed -
POST /interns: requiredcreatedAtproperty removedNo action needed -
POST /interns: requiredlastFailureMessageproperty removedNo action needed -
POST /interns: requiredupdatedAtproperty removedNo action needed -
POST /interns: requiredworkspaceIdproperty removedNo action needed -
POST /interns: propertiesstepLabelobject removedAction required- Update response parsing from
stepLabeltostep_label.
- Update response parsing from
-
POST /interns: propertiesstepNumberobject removedAction required- Update response parsing from
stepNumbertostep_number.
- Update response parsing from
-
POST /interns: propertiestotalStepsobject removedAction required- Update response parsing from
totalStepstototal_steps.
- Update response parsing from
-
POST /interns: requiredstep_labelproperty addedNo action needed -
POST /interns: requiredstep_numberproperty addedNo action needed -
POST /interns: requiredtotal_stepsproperty addedNo action needed -
POST /interns: requiredstepLabelproperty removedNo action needed -
POST /interns: requiredstepNumberproperty removedNo action needed -
POST /interns: requiredtotalStepsproperty removedNo action needed -
GET /interns/{internId}: propertiescreatedAtobject removedAction required- Update response parsing from
createdAttocreated_at.
- Update response parsing from
-
GET /interns/{internId}: propertieslastFailureMessageobject removedAction required- Update response parsing from
lastFailureMessagetolast_failure_message.
- Update response parsing from
-
GET /interns/{internId}: propertiesupdatedAtobject removedAction required- Update response parsing from
updatedAttoupdated_at.
- Update response parsing from
-
GET /interns/{internId}: propertiesworkspaceIdobject removedAction required- Update response parsing from
workspaceIdtoworkspace_id.
- Update response parsing from
-
GET /interns/{internId}: requiredcreated_atproperty addedNo action needed -
GET /interns/{internId}: requiredlast_failure_messageproperty addedNo action needed -
GET /interns/{internId}: requiredupdated_atproperty addedNo action needed -
GET /interns/{internId}: requiredworkspace_idproperty addedNo action needed -
GET /interns/{internId}: requiredcreatedAtproperty removedNo action needed -
GET /interns/{internId}: requiredlastFailureMessageproperty removedNo action needed -
GET /interns/{internId}: requiredupdatedAtproperty removedNo action needed -
GET /interns/{internId}: requiredworkspaceIdproperty removedNo action needed -
GET /interns/{internId}: propertiesstepLabelobject removedAction required- Update response parsing from
stepLabeltostep_label.
- Update response parsing from
-
GET /interns/{internId}: propertiesstepNumberobject removedAction required- Update response parsing from
stepNumbertostep_number.
- Update response parsing from
-
GET /interns/{internId}: propertiestotalStepsobject removedAction required- Update response parsing from
totalStepstototal_steps.
- Update response parsing from
-
GET /interns/{internId}: requiredstep_labelproperty addedNo action needed -
GET /interns/{internId}: requiredstep_numberproperty addedNo action needed -
GET /interns/{internId}: requiredtotal_stepsproperty addedNo action needed -
GET /interns/{internId}: requiredstepLabelproperty removedNo action needed -
GET /interns/{internId}: requiredstepNumberproperty removedNo action needed -
GET /interns/{internId}: requiredtotalStepsproperty removedNo action needed -
PATCH /interns/{internId}: propertiescreatedAtobject removedAction required- Update response parsing from
createdAttocreated_at.
- Update response parsing from
-
PATCH /interns/{internId}: propertieslastFailureMessageobject removedAction required- Update response parsing from
lastFailureMessagetolast_failure_message.
- Update response parsing from
-
PATCH /interns/{internId}: propertiesupdatedAtobject removedAction required- Update response parsing from
updatedAttoupdated_at.
- Update response parsing from
-
PATCH /interns/{internId}: propertiesworkspaceIdobject removedAction required- Update response parsing from
workspaceIdtoworkspace_id.
- Update response parsing from
-
PATCH /interns/{internId}: requiredcreated_atproperty addedNo action needed -
PATCH /interns/{internId}: requiredlast_failure_messageproperty addedNo action needed -
PATCH /interns/{internId}: requiredupdated_atproperty addedNo action needed -
PATCH /interns/{internId}: requiredworkspace_idproperty addedNo action needed -
PATCH /interns/{internId}: requiredcreatedAtproperty removedNo action needed -
PATCH /interns/{internId}: requiredlastFailureMessageproperty removedNo action needed -
PATCH /interns/{internId}: requiredupdatedAtproperty removedNo action needed -
PATCH /interns/{internId}: requiredworkspaceIdproperty removedNo action needed -
PATCH /interns/{internId}: propertiesstepLabelobject removedAction required- Update response parsing from
stepLabeltostep_label.
- Update response parsing from
-
PATCH /interns/{internId}: propertiesstepNumberobject removedAction required- Update response parsing from
stepNumbertostep_number.
- Update response parsing from
-
PATCH /interns/{internId}: propertiestotalStepsobject removedAction required- Update response parsing from
totalStepstototal_steps.
- Update response parsing from
-
PATCH /interns/{internId}: requiredstep_labelproperty addedNo action needed -
PATCH /interns/{internId}: requiredstep_numberproperty addedNo action needed -
PATCH /interns/{internId}: requiredtotal_stepsproperty addedNo action needed -
PATCH /interns/{internId}: requiredstepLabelproperty removedNo action needed -
PATCH /interns/{internId}: requiredstepNumberproperty removedNo action needed -
PATCH /interns/{internId}: requiredtotalStepsproperty removedNo action needed
Modified endpoints
POST /api/alpha/decisions: tags property_addedPOST /api/alpha/decisions: request schema updated; response schema updatedGET /interns: response schema updatedPOST /interns: response schema updatedGET /interns/{internId}: response schema updatedPATCH /interns/{internId}: response schema updated
Modified schemas
-
DecisionsScoreQuestion: minItems property_added- Used by
POST /api/alpha/decisions
- Used by
-
DecisionsChoiceQuestion: new union variant added; description updated; type property_removed- Used by
POST /api/alpha/decisions
- Used by
-
DecisionsNoulQuestion:- new union variant added
- property
falseupdated - property
trueupdated - description updated
- type property_removed
- Used by
POST /api/alpha/decisions
-
DecisionsScoreAnswer: new union variant added; description updated; type property_removed- Used by
POST /api/alpha/decisions
- Used by
-
DecisionsScoreQuestion: new union variant added; description updated; type property_removed- Used by
POST /api/alpha/decisions
- Used by
-
PublicEndpoint: new propertydecisions -
Intern:- example modified
- new property
created_at - new property
last_failure_message - new property
updated_at - new property
workspace_id - new property
step_label - new property
step_number - new property
total_steps
-
InternListResponse: example modified- Used by
GET /interns
- Used by
-
VaultSecret: description updated
BYOKContainersDecisionsInternsModelsPresetsResponsesSchemas
New endpoints
POST /interns/{internId}/chat/completions: Stream a chat completion with an internPOST /api/alpha/decisions: Submit a Decisions (questions and answers) request
Modified endpoints
GET /containers/{container_id}/files: description updatedPOST /presets/{slug}/responses: description updatedPOST /responses: description updated; response schema updatedGET /byok: parameterproviderupdatedGET /models: description updatedGET /models/count: description updatedGET /models/user: description updatedPOST /api/alpha/decisions: x-speakeasy-name-override modified
New schemas
InternApprovalModeInternChatAssistantMessageInternChatChoiceInternChatCompletionChunkInternChatCompletionRequestInternChatDeltaInternChatDeveloperMessageInternChatEchoedToolCallInternChatEchoedToolCallFunctionInternChatErrorInternChatErrorMetadataInternChatErrorResponseInternChatMessageInternChatMessageContentInternChatPromptTokensDetailsInternChatStreamErrorInternChatStreamingResponseInternChatSystemMessageInternChatTextPartInternChatToolCallInternChatToolCallFunctionInternChatToolMessageInternChatUsageInternChatUserMessageDecisionsChoiceAnswer- Used by
POST /api/alpha/decisions
- Used by
DecisionsChoiceQuestion- Used by
POST /api/alpha/decisions
- Used by
DecisionsNoulAnswer- Used by
POST /api/alpha/decisions
- Used by
DecisionsNoulQuestion- Used by
POST /api/alpha/decisions
- Used by
DecisionsRequest- Used by
POST /api/alpha/decisions
- Used by
DecisionsResponse- Used by
POST /api/alpha/decisions
- Used by
DecisionsScoreAnswer- Used by
POST /api/alpha/decisions
- Used by
DecisionsScoreQuestion- Used by
POST /api/alpha/decisions
- Used by
Modified schemas
-
AnthropicImageBlockParam: new union variant added -
ContainerFileListResponse: description updated -
InputImage: description updated; new propertyfile_id -
STTResponse: new propertyconfidence- Used by
POST /audio/transcriptions
- Used by
-
STTWord: example modified; new propertyconfidence- Used by
POST /audio/transcriptions
- Used by
-
BYOKProviderSlug: enum property_added -
GenerationResponse: propertyapi_typeupdated- Used by
GET /generation
- Used by
-
ImageOutputModality: enum property_added- Used by
GET /images/models
- Used by
-
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
OutputModality: enum property_added -
ProviderName: enum property_added -
ProviderOptions: new propertytypesafe -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
-
DecisionsRequest: new union variant added; description updated- Used by
POST /api/alpha/decisions
- Used by
-
VideoGenerationRequest: new propertyprevious_job_id- Used by
POST /videos
- Used by
-
VideoGenerationResponse: example modified; description updated- Used by
GET /videos/{jobId},POST /videos
- Used by
-
ProviderOptions: new propertyunbiased
API KeysBreakingEmbeddingsRerankSTTSchemasVault
Breaking changes
GET /key: requiredfree_model_daily_requestsproperty addedNo action neededGET /key: requiredallowed_data_regionsproperty addedNo action needed
New endpoints
GET /vault/interns/{internId}/secrets: List intern secretsPOST /vault/interns/{internId}/secrets/copy: Copy workspace secrets to an internPUT /vault/interns/{internId}/secrets/{name}: Store an intern secretDELETE /vault/interns/{internId}/secrets/{name}: Delete an intern secretGET /vault/secrets: List workspace secretsPUT /vault/secrets/{name}: Store a workspace secretDELETE /vault/secrets/{name}: Delete a workspace secret
Modified endpoints
GET /key: response schema updatedPOST /embeddings: request schema updatedPOST /rerank: request schema updatedPOST /audio/transcriptions: request schema updated
New response codes
POST /audio/transcriptions: now returns504
New schemas
-
FreeModelDailyRequests- Used by
GET /key
- Used by
-
GatewayTimeoutResponse- Used by
POST /audio/transcriptions
- Used by
-
GatewayTimeoutResponseErrorData- Used by
POST /audio/transcriptions
- Used by
-
VaultSecret -
VaultSecretCopyRequest -
VaultSecretCopyResponse -
VaultSecretListResponse -
VaultSecretResponse -
VaultSecretWriteRequest
Modified schemas
OutputBashServerToolItem: new propertyerror; $ref modifiedOutputShellCallOutputItem: description updated; new propertyerror- Used by
POST /responses
- Used by
OutputShellServerToolItem: new propertyerror; $ref modifiedShellCallOutputItem: new propertyerrorImageGenerationRequest: new propertysession_id- Used by
POST /images
- Used by
STTRequest: new propertysession_id- Used by
POST /audio/transcriptions
- Used by
SpeechRequest: new propertysession_id- Used by
POST /audio/speech
- Used by
VideoGenerationRequest: new propertysession_id- Used by
POST /videos
- Used by
EmbeddingsGuardrailsRerankSchemas
Modified endpoints
POST /guardrails: description updatedPOST /rerank: request schema updatedPOST /embeddings: request schema updated
New response codes
PATCH /guardrails/{id}: now returns403POST /guardrails/{id}/assignments/keys: now returns403
Modified schemas
ImageGenerationRequest: enum property_added- Used by
POST /images
- Used by
ImageGenerationRequest: maxLength property_added- Used by
POST /images
- Used by
STTRequest: new propertyuser- Used by
POST /audio/transcriptions
- Used by
SpeechRequest: new propertyuser- Used by
POST /audio/speech
- Used by
VideoGenerationRequest: new propertyuser- Used by
POST /videos
- Used by
ImageGenerationRequest: new propertytrace- Used by
POST /images
- Used by
STTRequest: new propertytrace- Used by
POST /audio/transcriptions
- Used by
SpeechRequest: new propertytrace- Used by
POST /audio/speech
- Used by
VideoGenerationRequest: new propertytrace- Used by
POST /videos
- Used by
BYOKVideo Generation
Modified endpoints
GET /byok: parameterproviderupdated
New response codes
GET /videos/{jobId}/content: now returns409GET /videos/{jobId}/content: now returns410
Modified schemas
-
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertyassemblyai -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
BYOKPresets
Modified endpoints
POST /presets/{slug}/responses: request schema updatedGET /byok: parameterproviderupdated
Modified schemas
-
CustomTool: new propertyasync -
FusionPlugin: example modified; description updated -
FusionServerToolConfig: example modified -
FusionServerTool_OpenRouter: example modified -
NamespaceFunctionTool: new propertyasync -
OpenAIResponseCustomToolCall: new propertyasync -
OpenAIResponseFunctionToolCall: new propertyasync -
OutputCustomToolCallItem: new propertyasync -
OutputItemCustomToolCall: new propertyasync- Used by
POST /responses
- Used by
-
OutputItemFunctionCall: new propertyasync -
ResponsesErrorField: enum property_added- Used by
POST /responses
- Used by
-
BYOKProviderSlug: enum property_added
BreakingWorkspaces
Breaking changes
/workspaces/{id}/budgets: endpoint object removedAction required- SDK and Terraform callers: rename the path argument from
idtoworkspace_ref(workspaceRefin camelCase clients). The URL value itself is unchanged.
- SDK and Terraform callers: rename the path argument from
/workspaces/{id}/budgets/{interval}: endpoint object removedAction required- SDK and Terraform callers: rename the path argument from
idtoworkspace_ref(workspaceRefin camelCase clients). The URL value itself is unchanged.
- SDK and Terraform callers: rename the path argument from
New endpoints
GET /workspaces/{workspace_ref}/budgets: List workspace budgetsGET /workspaces/{workspace_ref}/budgets/{interval}: Get a workspace budgetPUT /workspaces/{workspace_ref}/budgets/{interval}: Create or update a workspace budgetDELETE /workspaces/{workspace_ref}/budgets/{interval}: Delete a workspace budget
BYOKBreakingSchemas
Breaking changes
-
BYOKKey: requiredis_byok_onlyproperty addedNo action needed -
BYOKKey: requiredis_requiredproperty addedNo action needed
Modified endpoints
GET /byok: parameterproviderupdated; response schema updatedPOST /byok: response schema updatedGET /byok/{id}: response schema updatedPATCH /byok/{id}: response schema updated
Modified schemas
-
BYOKKey:- example modified
- new property
is_byok_only - new property
is_required - description updated
-
BYOKProviderSlug: enum property_added -
CreateBYOKKeyRequest: new propertyis_byok_only; new propertyis_required; description updated- Used by
POST /byok
- Used by
-
CreateBYOKKeyResponse: example modified- Used by
POST /byok
- Used by
-
GetBYOKKeyResponse: example modified- Used by
GET /byok/{id}
- Used by
-
ListBYOKKeysResponse: example modified- Used by
GET /byok
- Used by
-
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertynear-ai -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
-
UpdateBYOKKeyRequest: new propertyis_byok_only; new propertyis_required; description updated- Used by
PATCH /byok/{id}
- Used by
-
UpdateBYOKKeyResponse: example modified- Used by
PATCH /byok/{id}
- Used by
-
AnthropicThinkingBlockBinding: new propertymismatch_behavior
BYOKBreakingSchemas
Breaking changes
-
SandboxSleepAfterSeconds: schema object removedAction required- Remove
sleep_after_secondsfrom bash and shell tool configuration. There is no replacement; container lifecycle now uses the service-managed behavior.
- Remove
-
BashServerToolConfig: propertiessleep_after_secondsobject removedAction required- Remove
sleep_after_secondsfrom bash and shell tool configuration. There is no replacement; container lifecycle now uses the service-managed behavior.
- Remove
-
ShellServerToolConfig: propertiessleep_after_secondsobject removedAction required- Remove
sleep_after_secondsfrom bash and shell tool configuration. There is no replacement; container lifecycle now uses the service-managed behavior.
- Remove
-
BYOKProviderSlug: enumncompassproperty removedAction required- Remove
ncompassfrom BYOK and provider configuration. The provider has been retired and has no replacement slug.
- Remove
-
ProviderName: enumNCompassproperty removedAction required- Remove
ncompassfrom BYOK and provider configuration. The provider has been retired and has no replacement slug.
- Remove
-
GET /byok: enumncompassproperty removedAction required- Remove
ncompassfrom BYOK and provider configuration. The provider has been retired and has no replacement slug.
- Remove
-
BYOKProviderSlug: enumprime-intellectproperty removedAction required- Replace the provider slug and configuration key
prime-intellectwithprimeintellect.
- Replace the provider slug and configuration key
-
ProviderOptions: propertiesprime-intellectobject removedAction required- Replace the provider slug and configuration key
prime-intellectwithprimeintellect.
- Replace the provider slug and configuration key
-
GET /byok: enumprime-intellectproperty removedAction required- Replace the provider slug and configuration key
prime-intellectwithprimeintellect.
- Replace the provider slug and configuration key
Modified endpoints
GET /byok: parameterproviderupdated
Modified schemas
-
ChatDeveloperMessage: new propertyconfiguration_update -
BYOKProviderSlug: enum property_added -
ProviderOptions: new propertyprimeintellect -
ImageGenerationRequest: enum property_added- Used by
POST /images
- Used by
Schemas
Modified schemas
STTInputAudio: pattern property_added- Used by
POST /audio/transcriptions
- Used by
BreakingObservability
Breaking changes
-
ObservabilityArizeDestination: requiredregionsproperty addedNo action needed -
ObservabilityBraintrustDestination: requiredregionsproperty addedNo action needed -
ObservabilityClickhouseDestination: requiredregionsproperty addedNo action needed -
ObservabilityDatadogDestination: requiredregionsproperty addedNo action needed -
ObservabilityGrafanaDestination: requiredregionsproperty addedNo action needed -
ObservabilityLangfuseDestination: requiredregionsproperty addedNo action needed -
ObservabilityLangsmithDestination: requiredregionsproperty addedNo action needed -
ObservabilityNewrelicDestination: requiredregionsproperty addedNo action needed -
ObservabilityOpikDestination: requiredregionsproperty addedNo action needed -
ObservabilityOtelCollectorDestination: requiredregionsproperty addedNo action needed -
ObservabilityPosthogDestination: requiredregionsproperty addedNo action needed -
ObservabilityRampDestination: requiredregionsproperty addedNo action needed -
ObservabilityS3Destination: requiredregionsproperty addedNo action needed -
ObservabilitySentryDestination: requiredregionsproperty addedNo action needed -
ObservabilitySnowflakeDestination: requiredregionsproperty addedNo action needed -
ObservabilityWeaveDestination: requiredregionsproperty addedNo action needed -
ObservabilityWebhookDestination: requiredregionsproperty addedNo action needed -
GET /observability/destinations: requiredregionsproperty addedNo action needed
Modified endpoints
GET /observability/destinations: response schema updatedPOST /observability/destinations: response schema updatedGET /observability/destinations/{id}: response schema updatedPATCH /observability/destinations/{id}: response schema updated
New schemas
-
ObservabilityDataRegion -
ObservabilityDataRegionInput
Modified schemas
-
CreateObservabilityDestinationRequest: new propertyregions- Used by
POST /observability/destinations
- Used by
-
CreateObservabilityDestinationResponse: example modified- Used by
POST /observability/destinations
- Used by
-
GetObservabilityDestinationResponse: example modified -
ListObservabilityDestinationsResponse: example modified- Used by
GET /observability/destinations
- Used by
-
ObservabilityArizeDestination: example modified; new propertyregions -
ObservabilityBraintrustDestination: example modified; new propertyregions -
ObservabilityClickhouseDestination: example modified; new propertyregions -
ObservabilityDatadogDestination: example modified; new propertyregions -
ObservabilityDestination: example modified -
ObservabilityGrafanaDestination: example modified; new propertyregions -
ObservabilityLangfuseDestination: example modified; new propertyregions -
ObservabilityLangsmithDestination: example modified; new propertyregions -
ObservabilityNewrelicDestination: example modified; new propertyregions -
ObservabilityOpikDestination: example modified; new propertyregions -
ObservabilityOtelCollectorDestination: example modified; new propertyregions -
ObservabilityPosthogDestination: example modified; new propertyregions -
ObservabilityRampDestination: example modified; new propertyregions -
ObservabilityS3Destination: example modified; new propertyregions -
ObservabilitySentryDestination: example modified; new propertyregions -
ObservabilitySnowflakeDestination: example modified; new propertyregions -
ObservabilityWeaveDestination: example modified; new propertyregions -
ObservabilityWebhookDestination: example modified; new propertyregions -
UpdateObservabilityDestinationRequest: new propertyregions -
UpdateObservabilityDestinationResponse: example modified
MCPSCIMSchemas
New endpoints
POST /scim/sync-jobs: Start a SCIM directory syncGET /scim/sync-jobs/{id}: Get SCIM directory sync status
New schemas
-
CreateScimSyncJobResponse- Used by
POST /scim/sync-jobs
- Used by
-
GetScimSyncJobResponse- Used by
GET /scim/sync-jobs/{id}
- Used by
-
ScimSyncJob -
ConfigurationUpdateItem -
ConfigurationUpdateReasoning -
McpHttpError -
McpProtocolError -
McpToolCallError -
McpToolExecutionError
Modified schemas
-
ChatSystemMessage: new propertyconfiguration_update -
McpCallItem: $ref modified -
ResponsesErrorField: enum property_added- Used by
POST /responses
- Used by
-
SandboxSleepAfterSeconds: description updated; example modified
API KeysBYOKGuardrailsOAuth
New endpoints
GET /oauth/jwks: OpenRouter access token signing keysPOST /oauth/token: Exchange a workload identity token
Modified endpoints
POST /keys: description updated; request schema updatedDELETE /keys/{hash}: description updatedPATCH /keys/{hash}: description updatedPOST /guardrails: description updated; request schema updatedPATCH /guardrails/{id}: description updatedGET /byok: parameterproviderupdated
New response codes
PATCH /guardrails/{id}: now returns409
New schemas
OAuthErrorResponse- Used by
POST /oauth/token
- Used by
OAuthJwks- Used by
GET /oauth/jwks
- Used by
TokenExchangeRequest- Used by
POST /oauth/token
- Used by
TokenExchangeResponse- Used by
POST /oauth/token
- Used by
Modified schemas
-
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertyprime-intellect -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
API KeysBreakingEmbeddingsRerankSCIMSTTSchemasTTSVideo Generation
Breaking changes
POST /keys: propertiesexternal_api_keyobject removedNo action neededPOST /keys: propertiesexternal_userobject removedNo action needed
Modified endpoints
POST /scim/group-mappings: description updatedPOST /keys: description updated
New response codes
POST /audio/speech: now returns403POST /audio/transcriptions: now returns403POST /embeddings: now returns403POST /rerank: now returns403POST /videos: now returns403GET /videos/{jobId}: now returns403GET /videos/{jobId}/content: now returns403
New schemas
-
GuardrailDataRegion
Modified schemas
-
CostDetails: example modified; description updated -
Usage: example modified- Used by
POST /responses
- Used by
-
ChatContentVideoInput: new propertyprocessing -
InputVideo: new propertyprocessing -
Legacy_ChatContentVideoInput: new propertyprocessing -
OpenRouterMetadata: example modified; new propertygeneration_time -
CreateGuardrailRequest: new propertyallowed_data_regions- Used by
POST /guardrails
- Used by
-
Guardrail: example modified; new propertyallowed_data_regions -
UpdateGuardrailRequest: new propertyallowed_data_regions- Used by
PATCH /guardrails/{id}
- Used by
BYOKBreakingModelsSchemas
Breaking changes
AnthropicThinkingBlockBinding: requiredprefix_mismatch_behaviorproperty removedNo action neededAnthropicThinkingBlockBinding: typestringmodifiedNo action needed
Modified endpoints
GET /models: description updatedGET /models/count: description updatedGET /models/user: description updatedGET /byok: parameterproviderupdated
New schemas
AnthropicInputTransformation- Used by
POST /messages
- Used by
AnthropicMessageOutputConfigAnthropicOutputEffortAnthropicSystemClearAtAnthropicThinkingBlockBindingORAnthropicServerToolUsage- Used by
POST /messages
- Used by
AnthropicContainerSkill- Used by
POST /messages
- Used by
Modified schemas
-
BYOKProviderSlug: enum property_added -
AnthropicThinkingDisplay: enum property_added -
BaseMessagesResult: new propertyinput_transformations- Used by
POST /messages
- Used by
-
MessagesMessageParam: new propertyclear_at; new propertyoutput_config -
MessagesStartEvent: new propertyinput_transformations- Used by
POST /messages
- Used by
-
MessagesDeltaEvent: propertyserver_tool_useupdated- Used by
POST /messages
- Used by
-
AnthropicContainer: example modified; new propertyskills- Used by
POST /messages
- Used by
-
AnthropicSystemClearAt: enum property_added -
AnthropicThinkingBlockBinding: enum property_added
Schemas
Modified schemas
-
CostDetails: example modified; new propertyserver_tool_cost -
Usage: example modified- Used by
POST /responses
- Used by
-
OutputCustomToolCallItem: example modified; new propertystatus -
OutputItemCustomToolCall: example modified; new propertystatus- Used by
POST /responses
- Used by
API KeysAnalyticsOAuth
Modified endpoints
POST /analytics/query: description updated; request schema updatedPOST /auth/keys/code: description updatedPOST /keys: description updated
BYOKBreakingContainersModels
Breaking changes
PublicEndpoint: requiredsupports_tool_choiceproperty addedNo action needed
Modified endpoints
POST /containers/{container_id}/files/{file_id}/promote: description updated; response schema updatedGET /byok: parameterproviderupdatedGET /models/user: description updated; new parameteroutput_modalities
New schemas
ToolChoiceSupport
Modified schemas
-
PublicEndpoint: example modified; new propertysupports_tool_choice -
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertyollama -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
-
ProviderOptions: new propertycosine
Schemas
Modified schemas
CreateGuardrailResponse: example modified- Used by
POST /guardrails
- Used by
GetGuardrailResponse: example modified- Used by
GET /guardrails/{id}
- Used by
ListGuardrailsResponse: example modified- Used by
GET /guardrails
- Used by
UpdateGuardrailResponse: example modified- Used by
PATCH /guardrails/{id}
- Used by
BreakingContainersFilesSchemasWorkspaces
Breaking changes
GET /containers/{container_id}/files: x-hiddentrueobject removedNo action neededGET /containers/{container_id}/files/{file_id}: x-hiddentrueobject removedNo action neededGET /containers/{container_id}/files/{file_id}/content: x-hiddentrueobject removedNo action neededPOST /containers/{container_id}/files/{file_id}/promote: x-hiddentrueobject removedNo action neededGET /files: x-hiddentrueobject removedNo action neededPOST /files: x-hiddentrueobject removedNo action neededDELETE /files/{file_id}: x-hiddentrueobject removedNo action neededGET /files/{file_id}: x-hiddentrueobject removedNo action neededGET /files/{file_id}/content: x-hiddentrueobject removedNo action needed
Modified endpoints
DELETE /workspaces/{id}: description updatedDELETE /workspaces/{id}: new parameterconfirm_default_workspace_deletionDELETE /files/{file_id}: parameterfile_idupdatedGET /files/{file_id}: parameterfile_idupdatedGET /files/{file_id}/content: parameterfile_idupdated
Modified schemas
-
ImageGenerationRequest: new propertyuser- Used by
POST /images
- Used by
-
ShellCallOutputItem: new propertycontainer_id; new propertyfiles -
ContentFilterBuiltinEntry: description updated -
ContentFilterBuiltinSlug: enum property_added
ContainersRerankSTTSchemasTTSVideo Generation
New endpoints
POST /containers/{container_id}/files/{file_id}/promote: Promote a container file into workspace documents
New response codes
POST /audio/speech: now returns413POST /audio/transcriptions: now returns413POST /rerank: now returns413POST /videos: now returns413
New schemas
-
ContainerNetworkPolicy -
ContainerFileIds
Modified schemas
-
ContainerAutoEnvironment: new propertynetwork_policy -
ContainerReferenceEnvironment: new propertynetwork_policy -
SandboxSleepAfterSeconds: description updated -
ContainerAutoEnvironment: new propertyfile_ids -
ContainerReferenceEnvironment: new propertyfile_ids -
PublicEndpoint: description updated -
TopProviderInfo: description updated -
CreateGuardrailRequest: description updated- Used by
POST /guardrails
- Used by
-
ImagePricingEntry: enum property_added -
FusionPlugin: description updated
API KeysBreakingContainersSchemas
Breaking changes
-
ContainerReferenceEnvironment: maxLength20modifiedNo action needed- No action required for existing consumers. The maximum container reference length increased from 20 to 40 characters.
-
/containers/{session_id}/files: endpoint object removedAction required- Use the corresponding
/containers/{container_id}/...endpoint and pass the canonicalcontainer_idreturned by a bash or shell tool result instead of the original session ID.
- Use the corresponding
-
/containers/{session_id}/files/{file_id}: endpoint object removedAction required- Use the corresponding
/containers/{container_id}/...endpoint and pass the canonicalcontainer_idreturned by a bash or shell tool result instead of the original session ID.
- Use the corresponding
-
/containers/{session_id}/files/{file_id}/content: endpoint object removedAction required- Use the corresponding
/containers/{container_id}/...endpoint and pass the canonicalcontainer_idreturned by a bash or shell tool result instead of the original session ID.
- Use the corresponding
-
ObservabilityDatadogDestination: defaulthttps://api.us5.datadoghq.commodifiedAction required- If your Datadog site is US5 and you relied on the omitted URL default, explicitly set
urltohttps://api.us5.datadoghq.com. The new default is the US1 endpoint,https://api.datadoghq.com.
- If your Datadog site is US5 and you relied on the omitted URL default, explicitly set
-
GET /keys: requiredexternal_userproperty addedNo action needed -
POST /keys: requiredexternal_userproperty addedAction required- Connect client-secret callers must include a non-empty
external_userwhen creating a key. Management-key callers should continue to omit this Connect-only field.
- Connect client-secret callers must include a non-empty
-
GET /keys/{hash}: requiredexternal_userproperty addedNo action needed -
PATCH /keys/{hash}: requiredexternal_userproperty addedNo action needed
New endpoints
GET /containers/{session_id}/files: List container filesGET /containers/{session_id}/files/{file_id}: Retrieve a container fileGET /containers/{session_id}/files/{file_id}/content: Download container file contentGET /containers/{container_id}/files: List container filesGET /containers/{container_id}/files/{file_id}: Retrieve a container fileGET /containers/{container_id}/files/{file_id}/content: Download container file content
Modified endpoints
POST /keys: request schema updatedGET /keys: response schema updatedPOST /keys: description updated; request schema updated; response schema updatedGET /keys/{hash}: response schema updatedPATCH /keys/{hash}: response schema updatedDELETE /keys/{hash}: description updatedPATCH /keys/{hash}: description updated
New schemas
ContainerFileContainerFileListResponse
Modified schemas
-
ContainerFile: description updated; example modified -
ContainerReferenceEnvironment: description updated; example modified -
MessagesBashToolResultBlock: new propertycontainer_id; new propertyfiles -
MessagesShellToolResultBlock: new propertycontainer_id; new propertyfiles -
ORAnthropicBashToolResult: new propertycontainer_id; new propertyfiles- Used by
POST /messages
- Used by
-
ORAnthropicShellToolResult: new propertycontainer_id; new propertyfiles- Used by
POST /messages
- Used by
-
OutputBashServerToolItem: new propertycontainer_id; new propertyfiles -
OutputShellCallOutputItem: new propertycontainer_id; new propertyfiles- Used by
POST /responses
- Used by
-
OutputShellServerToolItem: new propertycontainer_id; new propertyfiles -
ObservabilityDatadogDestination: example modified; propertyurlupdated -
PricingOverride: new propertyutc_days
Schemas
New schemas
-
ToolSearchServerTool -
ToolSearchServerToolConfig
Modified schemas
AdditionalToolsItem: new union variant addedMessagesRequest: new union variant addedResponsesRequest: new union variant added
BYOKEmbeddings
Modified endpoints
POST /byok: description updatedPATCH /byok/{id}: description updatedGET /byok: parameterproviderupdated
New response codes
POST /embeddings: now returns408POST /embeddings: now returns413
Modified schemas
-
CreateBYOKKeyRequest: new propertyallowed_api_key_hashes- Used by
POST /byok
- Used by
-
UpdateBYOKKeyRequest: new propertyallowed_api_key_hashes- Used by
PATCH /byok/{id}
- Used by
-
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertymakora -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
AnalyticsBreakingGuardrailsSchemas
Breaking changes
GET /analytics/meta: tagsbeta.Analyticsproperty removedNo action neededPOST /analytics/query: tagsbeta.Analyticsproperty removedNo action needed- $.tags: beta.Analytics object removedNo action needed
Modified endpoints
GET /analytics/meta: tags property_addedPOST /analytics/query: tags property_addedPOST /guardrails: description updated
Modified schemas
-
ReasoningFormat: enum property_added -
CreateGuardrailRequest: description updated- Used by
POST /guardrails
- Used by
-
Guardrail: description updated
BYOKBreakingSchemas
Breaking changes
-
AdvisorNestedTool: schema object removedAction required- Remove
toolsandmax_tool_callsfrom advisor tool configuration. Advisors no longer run nested tool-calling loops.
- Remove
-
AdvisorServerToolConfig: propertiesmax_tool_callsobject removedAction required- Remove
toolsandmax_tool_callsfrom advisor tool configuration. Advisors no longer run nested tool-calling loops.
- Remove
-
AdvisorServerToolConfig: propertiestoolsobject removedAction required- Remove
toolsandmax_tool_callsfrom advisor tool configuration. Advisors no longer run nested tool-calling loops.
- Remove
-
VideoModel: requiredcreativityproperty addedNo action needed- Used by
GET /videos/models
- Used by
-
VideoModel: requiredupscale_factorproperty addedNo action needed- Used by
GET /videos/models
- Used by
-
CustomToolCallItem: propertiescall_idobject removedNo action needed -
CustomToolCallItem: propertiesidobject removedNo action needed -
CustomToolCallItem: propertiesinputobject removedNo action needed -
CustomToolCallItem: propertiesnameobject removedNo action needed -
CustomToolCallItem: propertiesnamespaceobject removedNo action needed -
CustomToolCallItem: propertiestypeobject removedNo action needed -
CustomToolCallItem: requiredcall_idproperty removedNo action needed -
CustomToolCallItem: requiredinputproperty removedNo action needed -
CustomToolCallItem: requirednameproperty removedNo action needed -
CustomToolCallItem: requiredtypeproperty removedNo action needed
New capabilities
- BYOK API: manage credential restrictions (
allowed_models,allowed_user_ids,allowed_api_key_hashes) via create/update. See the BYOK guide for examples and validation rules.
New schemas
FailableToolCallStatus
Modified schemas
-
AdvisorServerToolConfig: description updated -
AdvisorServerTool_OpenRouter: description updated -
VideoGenerationRequest: new propertycreativity; new propertyupscale_factor- Used by
POST /videos
- Used by
-
VideoModel: new propertycreativity; new propertyupscale_factor- Used by
GET /videos/models
- Used by
-
OutputAdvisorServerToolItem: description updated; $ref modified -
OutputSubagentServerToolItem: description updated; $ref modified -
CustomToolCallItem: allOf object_added; type property_removed
BreakingSchemasbeta.Analytics
Breaking changes
POST /analytics/query: maxItems10modifiedAction required- Limit
classifier_dimensions.dimension_namesto at most two entries. Split requests that previously queried three or more classifier dimensions.
- Limit
Modified endpoints
POST /analytics/query: description updated
Modified schemas
-
ProviderOptions: new propertyanthropic/2
BreakingPresetsSchemasWorkspaces
Breaking changes
- spec: string modifiedNo action needed
OutputBashServerToolItem: typestringmodifiedNo action neededPOST /presets/{slug}/responses: typestringmodifiedNo action needed
Modified endpoints
DELETE /workspaces/{id}: description updated
New schemas
OutputShellServerToolItemShellCallOutputContent
Modified schemas
-
OpenAIResponseFunctionToolCall: new propertysubagent_id; new propertysubagent_items -
OutputSubagentServerToolItem: new propertycall_id -
SubagentReasoning: description updated -
SubagentServerToolConfig: new propertyinherit_functions; new propertyinherited_function_names; description updated -
OutputFilesServerToolItem: new propertyarguments; new propertycall_id -
OutputItems: new union variant added- Used by
POST /responses
- Used by
-
OutputShellCallItem: new propertyarguments- Used by
POST /responses
- Used by
-
OutputShellCallOutputItem: $ref modified- Used by
POST /responses
- Used by
-
ShellCallItem: new propertyarguments -
ShellCallOutputItem: example modified; $ref modified -
ProviderOptions: new propertyamazon-bedrock/claude-on-aws
DatasetsSchemas
Modified endpoints
GET /datasets/app-rankings: description updatedGET /datasets/rankings-daily: description updatedGET /datasets/session-cost: description updated
Modified schemas
AnthropicRefusalStopDetails: enum property_added- Used by
POST /messages
- Used by
OutputFusionServerToolItem: description updated
Anthropic MessagesBreakingGenerationsSchemasWorkspaces
Breaking changes
MessagesErrorDetail: schema object removedNo action neededMessagesErrorResponse: schema object removedNo action needed
Modified endpoints
GET /generation/content: response schema updatedPOST /messages: response schema updated; description updatedDELETE /workspaces/{id}: description updated
New schemas
AnthropicMessagesErrorResponse- Used by
POST /messages
- Used by
Modified schemas
-
ImageGenerationRequest: description updated- Used by
POST /images
- Used by
-
WebSearchMode: description updated
DatasetsModelsWorkspaces
New endpoints
GET /datasets/session-cost: Cost per session by harness and model
Modified endpoints
GET /models: description updated; parameterregionupdatedGET /models/user: description updatedDELETE /workspaces/{id}: description updated; new parameterconfirm_default_settings_deletion
New schemas
SessionCostItem- Used by
GET /datasets/session-cost
- Used by
SessionCostMeta- Used by
GET /datasets/session-cost
- Used by
SessionCostResponse- Used by
GET /datasets/session-cost
- Used by
Modified schemas
-
AutoBetaRouterPlugin: description updated; maxItems property_added; maxLength property_added -
AutoRouterPlugin: description updated; maxItems property_added; maxLength property_added
BYOKBenchmarksBreakingGenerationsSchemas
Breaking changes
UnifiedBenchmarksResponse: discriminatordiscriminatorobject removedNo action needed- Used by
GET /benchmarks
- Used by
GenerationContentData: requirederrorproperty addedNo action needed- Used by
GET /generation/content
- Used by
Modified endpoints
GET /benchmarks:- description updated
- new parameter
benchmark_type - new parameter
include_run_config - new parameter
search_engine - new parameter
search_surface - parameter
task_typeupdated
GET /generation/content: description updated; response schema updatedGET /byok: parameterproviderupdated
New schemas
UnifiedBenchmarksSearchItem- Used by
GET /benchmarks
- Used by
UnifiedBenchmarksSearchRunConfig- Used by
GET /benchmarks
- Used by
GenerationContentError- Used by
GET /generation/content
- Used by
GenerationContentErrorAttempt- Used by
GET /generation/content
- Used by
Modified schemas
-
OutputFusionServerToolItem: description updated -
WebSearchMode: description updated -
MessagesStartEvent: propertyusageupdated- Used by
POST /messages
- Used by
-
UnifiedBenchmarksResponse: new union variant added- Used by
GET /benchmarks
- Used by
-
GenerationContentData: description updated; example modified; new propertyerror- Used by
GET /generation/content
- Used by
-
GenerationContentResponse: example modified- Used by
GET /generation/content
- Used by
-
AppRankingsResponse: example modified- Used by
GET /datasets/app-rankings
- Used by
-
RankingsDailyMeta: example modified -
RankingsDailyResponse: example modified- Used by
GET /datasets/rankings-daily
- Used by
-
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertydatabricks -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
BreakingPresetsSchemas
Breaking changes
- spec: additionalProperties object addedNo action needed
CodeInterpreterCallItem: propertiescodeobject removedNo action neededCodeInterpreterCallItem: propertiescontainer_idobject removedNo action neededCodeInterpreterCallItem: propertiesidobject removedNo action neededCodeInterpreterCallItem: propertiesoutputsobject removedNo action neededCodeInterpreterCallItem: propertiesstatusobject removedNo action neededCodeInterpreterCallItem: propertiestypeobject removedNo action neededCodeInterpreterCallItem: requiredcodeproperty removedNo action neededCodeInterpreterCallItem: requiredcontainer_idproperty removedNo action neededCodeInterpreterCallItem: requiredidproperty removedNo action neededCodeInterpreterCallItem: requiredoutputsproperty removedNo action neededCodeInterpreterCallItem: requiredstatusproperty removedNo action neededCodeInterpreterCallItem: requiredtypeproperty removedNo action neededOutputItemWebSearchCall: additionalPropertiesadditionalPropertiesobject addedNo action neededPOST /presets/{slug}/responses: propertiescodeobject removedNo action neededPOST /presets/{slug}/responses: propertiescontainer_idobject removedNo action neededPOST /presets/{slug}/responses: propertiesidobject removedNo action neededPOST /presets/{slug}/responses: propertiesoutputsobject removedNo action neededPOST /presets/{slug}/responses: propertiesstatusobject removedNo action neededPOST /presets/{slug}/responses: propertiestypeobject removedNo action neededPOST /presets/{slug}/responses: requiredcodeproperty removedNo action neededPOST /presets/{slug}/responses: requiredcontainer_idproperty removedNo action neededPOST /presets/{slug}/responses: requiredidproperty removedNo action neededPOST /presets/{slug}/responses: requiredoutputsproperty removedNo action neededPOST /presets/{slug}/responses: requiredstatusproperty removedNo action neededPOST /presets/{slug}/responses: requiredtypeproperty removedNo action needed
Modified endpoints
POST /presets/{slug}/responses: request schema updated
New schemas
CodeInterpreterCallCodeDeltaEvent- Used by
POST /responses
- Used by
CodeInterpreterCallCodeDoneEvent- Used by
POST /responses
- Used by
CodeInterpreterCallCompletedEvent- Used by
POST /responses
- Used by
CodeInterpreterCallInProgressEvent- Used by
POST /responses
- Used by
CodeInterpreterCallInterpretingEvent- Used by
POST /responses
- Used by
CodeInterpreterFileOutputCodeInterpreterImageOutputCodeInterpreterLogsOutputOpenAIResponsesCodeInterpreterCallCodeDelta- Used by
POST /responses
- Used by
OpenAIResponsesCodeInterpreterCallCodeDone- Used by
POST /responses
- Used by
OpenAIResponsesCodeInterpreterCallCompleted- Used by
POST /responses
- Used by
OpenAIResponsesCodeInterpreterCallInProgress- Used by
POST /responses
- Used by
OpenAIResponsesCodeInterpreterCallInterpreting- Used by
POST /responses
- Used by
OutputItemCodeInterpreterCall
Modified schemas
-
AutoBetaRouterPlugin: description updated -
AutoRouterPlugin: example modified; description updated -
BaseResponsesResult: new union variant added- Used by
POST /responses
- Used by
-
CodeInterpreterCallItem: allOf object_added; type property_removed -
OutputItemAddedEvent: new union variant added- Used by
POST /responses
- Used by
-
OutputItemDoneEvent: new union variant added- Used by
POST /responses
- Used by
-
StreamEvents: new union variant added- Used by
POST /responses
- Used by
Schemas
Modified schemas
-
VideoModel: enum property_added- Used by
GET /videos/models
- Used by
-
FusionServerToolConfig: description updated
BYOKBreakingObservabilitySchemas
Breaking changes
-
BYOKKey: typestringmodifiedAction required- Allow
workspace_idto benullin BYOK responses. A null value identifies a global credential that is usable across every workspace; do not substitute the default workspace.
- Allow
-
Guardrail: typestringmodifiedAction required- Allow
workspace_idto benullin guardrail responses. A null value identifies an unscoped legacy guardrail; it does not mean the default workspace or every workspace.
- Allow
-
ObservabilityArizeDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityArizeDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityArizeDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityBraintrustDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityBraintrustDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityBraintrustDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityClickhouseDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityClickhouseDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityClickhouseDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityDatadogDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityDatadogDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityDatadogDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityGrafanaDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityGrafanaDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityGrafanaDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityLangfuseDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityLangfuseDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityLangfuseDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityLangsmithDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityLangsmithDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityLangsmithDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityNewrelicDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityNewrelicDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityNewrelicDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityOpikDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityOpikDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityOpikDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityOtelCollectorDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityOtelCollectorDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityOtelCollectorDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityPosthogDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityPosthogDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityPosthogDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityRampDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityRampDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityRampDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityS3Destination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityS3Destination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityS3Destination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilitySentryDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilitySentryDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilitySentryDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilitySnowflakeDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilitySnowflakeDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilitySnowflakeDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityWeaveDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityWeaveDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityWeaveDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
ObservabilityWebhookDestination: requiredbroadcast_generation_costproperty addedNo action needed -
ObservabilityWebhookDestination: requiredbroadcast_generation_identityproperty addedNo action needed -
ObservabilityWebhookDestination: requiredbroadcast_generation_request_contextproperty addedNo action needed -
GET /observability/destinations: requiredbroadcast_generation_costproperty addedNo action needed -
GET /observability/destinations: requiredbroadcast_generation_identityproperty addedNo action needed -
GET /observability/destinations: requiredbroadcast_generation_request_contextproperty addedNo action needed
Modified endpoints
GET /byok: description updatedPOST /byok: description updatedGET /observability/destinations: response schema updatedPOST /observability/destinations: response schema updatedGET /observability/destinations/{id}: response schema updatedPATCH /observability/destinations/{id}: response schema updated
New response codes
PATCH /observability/destinations/{id}: now returns403
New schemas
-
WebSearchMode
Modified schemas
-
BYOKKey: description updated -
CreateBYOKKeyRequest: description updated- Used by
POST /byok
- Used by
-
CreateGuardrailRequest: description updated- Used by
POST /guardrails
- Used by
-
CreateObservabilityDestinationRequest: new propertybroadcast_generation_cost; new propertybroadcast_generation_identity; new propertybroadcast_generation_request_context- Used by
POST /observability/destinations
- Used by
-
CreateObservabilityDestinationResponse: example modified- Used by
POST /observability/destinations
- Used by
-
FusionPlugin: description updated -
FusionServerToolConfig: description updated -
GetObservabilityDestinationResponse: example modified -
Guardrail: description updated -
ListObservabilityDestinationsResponse: example modified- Used by
GET /observability/destinations
- Used by
-
ObservabilityArizeDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityBraintrustDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityClickhouseDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityDatadogDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityDestination: example modified -
ObservabilityGrafanaDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityLangfuseDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityLangsmithDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityNewrelicDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityOpikDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityOtelCollectorDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityPosthogDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityRampDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityS3Destination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilitySentryDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilitySnowflakeDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityWeaveDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
ObservabilityWebhookDestination:- example modified
- new property
broadcast_generation_cost - new property
broadcast_generation_identity - new property
broadcast_generation_request_context
-
UpdateObservabilityDestinationRequest: new propertybroadcast_generation_cost; new propertybroadcast_generation_identity; new propertybroadcast_generation_request_context -
UpdateObservabilityDestinationResponse: example modified -
ChatWebSearchShorthand: new propertymode -
InputReference: description updated- Used by
POST /videos
- Used by
-
Legacy_WebSearchServerTool: new propertymode -
Preview_20250311_WebSearchServerTool: new propertymode -
Preview_WebSearchServerTool: new propertymode -
VideoGenerationRequest: description updated- Used by
POST /videos
- Used by
-
WebSearchConfig: new propertymode -
WebSearchPlugin: new propertymode -
WebSearchServerTool: new propertymode -
WebSearchServerToolConfig: new propertymode
FilesSchemas
Modified endpoints
POST /files: description updated
Modified schemas
-
FilesServerTool: description updated
SchemasWorkspacesbeta.Analytics
Modified endpoints
POST /analytics/query: request schema updated
New response codes
DELETE /workspaces/{id}/budgets/{interval}: now returns400
New schemas
GetWorkspaceBudgetResponseMessagesBashToolResultBlockMessagesShellToolResultBlockORAnthropicBashToolResult- Used by
POST /messages
- Used by
ORAnthropicShellToolResult- Used by
POST /messages
- Used by
Modified schemas
-
ObservabilitySnowflakeDestination: propertyaccountupdated -
MessagesContentBlockStartEvent: new union variant added- Used by
POST /messages
- Used by
-
MessagesRequest: new union variant added -
ORAnthropicContentBlock: new union variant added- Used by
POST /messages
- Used by
AnalyticsBreakingEndpointsbeta.Analytics
Breaking changes
GenerationResponse: requiredworkspace_idproperty addedNo action needed- No action required for existing consumers. Generation responses now include
workspace_id, the ID of the workspace the generation belongs to. - Used by
GET /generation
- No action required for existing consumers. Generation responses now include
Modified endpoints
GET /activity:- x-speakeasy-max-method-params object_added
- description updated
- new parameter
group_by - new parameter
workspace_id
POST /analytics/query: description updatedGET /endpoints/zdr: response schema updated
New schemas
SpeechInputReference- Used by
POST /audio/speech
- Used by
SpeechInputReferenceAudio- Used by
POST /audio/speech
- Used by
SpeechInputReferenceAudioInput- Used by
POST /audio/speech
- Used by
SpeechInputReferenceText- Used by
POST /audio/speech
- Used by
Modified schemas
ActivityItem: new propertyworkspace_id- Used by
GET /activity
- Used by
GenerationResponse: example modified; new propertyworkspace_id- Used by
GET /generation
- Used by
PublicEndpoint: example modified; new propertysupports_voice_cloningSpeechRequest: new propertyinput_references- Used by
POST /audio/speech
- Used by
Guardrails
Modified endpoints
GET /guardrails/{id}: description updatedPATCH /guardrails/{id}: description updated
Modified schemas
-
Workspace: description updated
BYOKBreakingSCIMSchemas
Breaking changes
SpeechRequest: requiredvoiceproperty removedNo action needed- No action required for existing consumers.
voiceis now optional; requests that send it are unaffected. - Used by
POST /audio/speech
- No action required for existing consumers.
New endpoints
GET /scim/group-mappings: List SCIM group mappingsPOST /scim/group-mappings: Create a SCIM group mappingGET /scim/group-mappings/{id}: Get a SCIM group mappingPATCH /scim/group-mappings/{id}: Update a SCIM group mappingDELETE /scim/group-mappings/{id}: Delete a SCIM group mappingGET /scim/groups: List SCIM groups
Modified endpoints
GET /byok: parameterproviderupdated
New schemas
-
CreateScimGroupMappingRequest- Used by
POST /scim/group-mappings
- Used by
-
CreateScimGroupMappingResponse- Used by
POST /scim/group-mappings
- Used by
-
DeleteScimGroupMappingResponse- Used by
DELETE /scim/group-mappings/{id}
- Used by
-
GetScimGroupMappingResponse- Used by
GET /scim/group-mappings/{id}
- Used by
-
ListScimGroupMappingsResponse- Used by
GET /scim/group-mappings
- Used by
-
ListScimGroupsResponse- Used by
GET /scim/groups
- Used by
-
ScimGroup- Used by
GET /scim/groups
- Used by
-
ScimGroupMapping -
UpdateScimGroupMappingRequest- Used by
PATCH /scim/group-mappings/{id}
- Used by
-
UpdateScimGroupMappingResponse- Used by
PATCH /scim/group-mappings/{id}
- Used by
Modified schemas
-
VideoGenerationRequest: enum property_added- Used by
POST /videos
- Used by
-
VideoModel: enum property_added- Used by
GET /videos/models
- Used by
-
SpeechRequest: minLength property_added- Used by
POST /audio/speech
- Used by
-
BYOKProviderSlug: enum property_added -
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertythinkingmachines -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
-
ChatRequest: description updated; enum property_added -
ResponsesErrorField: enum property_added- Used by
POST /responses
- Used by
-
ResponsesRequest: description updated; enum property_added
BenchmarksBreakingFilesSchemasWorkspaces
Breaking changes
FileMetadata: schema object removedNo action neededFileDeleteResponse: discriminatordiscriminatorobject addedAction required- HTTP clients: no change. Requests without a vendor SDK still get the OpenRouter shape (
_shape: "openrouter") with the same fields as before. Typed SDK clients: this response type is now a union discriminated by_shape. In the TypeScript SDK, the field is namedshape, so checkshape === "openrouter"before reading OpenRouter fields such asidandtype. - Used by
DELETE /files/{file_id}
- HTTP clients: no change. Requests without a vendor SDK still get the OpenRouter shape (
FileDeleteResponse: propertiesidobject removedNo action needed- Used by
DELETE /files/{file_id}
- Used by
FileDeleteResponse: propertiestypeobject removedNo action needed- Used by
DELETE /files/{file_id}
- Used by
FileDeleteResponse: requiredidproperty removedNo action needed- Used by
DELETE /files/{file_id}
- Used by
FileDeleteResponse: requiredtypeproperty removedNo action needed- Used by
DELETE /files/{file_id}
- Used by
FileListResponse: discriminatordiscriminatorobject addedAction required- HTTP clients: no change. Requests without a vendor SDK still get the OpenRouter shape (
_shape: "openrouter") with the same fields as before. Typed SDK clients: this response type is now a union discriminated by_shape. In the TypeScript SDK, the field is namedshape, so checkshape === "openrouter"before reading OpenRouter fields such ascursor. - Used by
GET /files
- HTTP clients: no change. Requests without a vendor SDK still get the OpenRouter shape (
FileListResponse: propertiescursorobject removedNo action needed- Used by
GET /files
- Used by
FileListResponse: propertiesdataobject removedNo action needed- Used by
GET /files
- Used by
FileListResponse: propertiesfirst_idobject removedNo action needed- Used by
GET /files
- Used by
FileListResponse: propertieshas_moreobject removedNo action needed- Used by
GET /files
- Used by
FileListResponse: propertieslast_idobject removedNo action needed- Used by
GET /files
- Used by
FileListResponse: requiredcursorproperty removedNo action needed- Used by
GET /files
- Used by
FileListResponse: requireddataproperty removedNo action needed- Used by
GET /files
- Used by
FileListResponse: requiredfirst_idproperty removedNo action needed- Used by
GET /files
- Used by
FileListResponse: requiredhas_moreproperty removedNo action needed- Used by
GET /files
- Used by
FileListResponse: requiredlast_idproperty removedNo action needed- Used by
GET /files
- Used by
Modified endpoints
GET /benchmarks: description updated; parametersourceupdated; response schema updatedGET /files:- new parameter
after - new parameter
after_id - new parameter
before_id - new parameter
order - new parameter
provider
- new parameter
POST /files: new parameterprovider; response schema updatedDELETE /files/{file_id}: new parameterproviderGET /files/{file_id}: new parameterprovider; response schema updatedGET /files/{file_id}/content: new parameterproviderGET /workspaces: response schema updatedPOST /workspaces: response schema updatedGET /workspaces/{id}: response schema updatedPATCH /workspaces/{id}: response schema updatedGET /workspaces/{id}/budgets: response schema updatedPUT /workspaces/{id}/budgets/{interval}: description updated; request schema updated; response schema updated
New response codes
GET /files: now returns403GET /files: now returns502GET /files: now returns503POST /files: now returns502POST /files: now returns503DELETE /files/{file_id}: now returns403DELETE /files/{file_id}: now returns502DELETE /files/{file_id}: now returns503GET /files/{file_id}: now returns403GET /files/{file_id}: now returns502GET /files/{file_id}: now returns503GET /files/{file_id}/content: now returns403GET /files/{file_id}/content: now returns502GET /files/{file_id}/content: now returns503
New schemas
-
UnifiedBenchmarksORItem- Used by
GET /benchmarks
- Used by
-
AnthropicFile- Used by
GET /files,GET /files/{file_id},POST /files
- Used by
-
AnthropicFileDeleted- Used by
DELETE /files/{file_id}
- Used by
-
AnthropicFileList- Used by
GET /files
- Used by
-
FileProvider -
FileResponse- Used by
GET /files/{file_id},POST /files
- Used by
-
OpenAIFile- Used by
GET /files,GET /files/{file_id},POST /files
- Used by
-
OpenAIFileDeleted- Used by
DELETE /files/{file_id}
- Used by
-
OpenAIFileList- Used by
GET /files
- Used by
-
OpenRouterFile- Used by
GET /files,GET /files/{file_id},POST /files
- Used by
-
OpenRouterFileDeleted- Used by
DELETE /files/{file_id}
- Used by
-
OpenRouterFileList- Used by
GET /files
- Used by
-
ModelAliasTarget
Modified schemas
-
UnifiedBenchmarksMeta: enum property_added- Used by
GET /benchmarks
- Used by
-
UnifiedBenchmarksResponse: example modified; new union variant added- Used by
GET /benchmarks
- Used by
-
FileDeleteResponse:- description updated
- example modified
- new union variant added
- type property_removed
- Used by
DELETE /files/{file_id}
-
FileListResponse:- description updated
- example modified
- new union variant added
- type property_removed
- Used by
GET /files
-
CreateWorkspaceResponse: example modified- Used by
POST /workspaces
- Used by
-
GetWorkspaceResponse: example modified- Used by
GET /workspaces/{id}
- Used by
-
ListWorkspaceBudgetsResponse: example modified; new propertyinclude_byok_in_budgets- Used by
GET /workspaces/{id}/budgets
- Used by
-
ListWorkspacesResponse: example modified- Used by
GET /workspaces
- Used by
-
Model: new propertyalias_target -
UpdateWorkspaceResponse: example modified- Used by
PATCH /workspaces/{id}
- Used by
-
UpsertWorkspaceBudgetRequest: example modified; new propertyinclude_byok_in_budgets -
UpsertWorkspaceBudgetResponse: example modified; new propertyinclude_byok_in_budgets -
Workspace: example modified; new propertyinclude_byok_in_budgets -
AutoBetaRouterPlugin: example modified; new propertyexcluded_models -
AutoRouterPlugin: example modified; new propertyexcluded_models -
VideoModel: enum property_added- Used by
GET /videos/models
- Used by
BreakingFilesResponsesSchemas
Breaking changes
FusionCallAnalysisInProgressEvent: requiredanalyst_modelproperty addedNo action needed- No action required for existing consumers.
analyst_modelreplacesjudge_modelin this streaming event;judge_modelis retained as a deprecated alias that always carries the same value. - Used by
POST /responses
- No action required for existing consumers.
- $.tags: responses object removedNo action needed
- No action required. The
responsesOpenAPI tag was renamed toResponsesfor consistent Title Case across the API Reference. This is a documentation-grouping change only:POST /api/v1/responsesand 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.
- No action required. The
Modified endpoints
GET /files: parametercursorupdated; response schema updatedPOST /files: response schema updatedDELETE /files/{file_id}: parameterfile_idupdated; response schema updatedGET /files/{file_id}: parameterfile_idupdated; response schema updatedGET /files/{file_id}/content: parameterfile_idupdated
Modified schemas
-
FusionAnalysisResult: description updated -
FusionCallAnalysisCompletedEvent: description updated- Used by
POST /responses
- Used by
-
FusionCallAnalysisInProgressEvent:- description updated
- example modified
- new property
analyst_model - property
judge_modeldeprecated (alias ofanalyst_model, kept for existing consumers) - Used by
POST /responses
-
FusionPlugin: description updated -
FusionServerToolConfig: description updated; propertyeffortupdated; propertymax_tokensupdated -
FusionServerTool_OpenRouter: description updated -
FusionSource: description updated -
OutputFusionServerToolItem: description updated -
ChatWebSearchShorthand: description updated -
WebSearchConfig: description updated -
WebSearchDomainFilter: example modified; new propertyblocked_domains -
WebSearchServerToolConfig: description updated -
AnthropicFileDocumentSource: example modified -
FileDeleteResponse: example modified- Used by
DELETE /files/{file_id}
- Used by
-
FileListResponse: example modified- Used by
GET /files
- Used by
-
FileMetadata: example modified- Used by
GET /files,GET /files/{file_id},POST /files
- Used by
-
GenerationResponse: propertydata_regionupdated- Used by
GET /generation
- Used by
-
CreateGuardrailRequest: new propertyenable_free_model_publication; new propertyenable_free_model_training; new propertyenable_paid_model_training- Used by
POST /guardrails
- Used by
-
Guardrail:- example modified
- new property
enable_free_model_publication - new property
enable_free_model_training - new property
enable_paid_model_training
-
UpdateGuardrailRequest: new propertyenable_free_model_publication; new propertyenable_free_model_training; new propertyenable_paid_model_training- Used by
PATCH /guardrails/{id}
- Used by
-
AutoBetaRouterPlugin:- example modified
- new property
cost_tier - deprecated property_added
- description updated
-
AutoRouterPlugin:- example modified
- new property
cost_tier - deprecated property_added
- description updated
EmbeddingsSchemas
Modified endpoints
POST /embeddings: request schema updated
Modified schemas
-
Quantization: enum property_added -
ReasoningFormat: enum property_added
BYOKBreakingResponsesSchemas
Breaking changes
POST /responses: tagsbeta.responsesproperty removedNo action needed- Migration: no action for HTTP clients. The Responses API is now GA.
beta.responseswas an OpenAPI grouping tag and SDK namespace, never a URL.POST /api/v1/responsesand 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, withclient.responses.send()(TypeScript, Python) andclient.Responses.Send()(Go). Thebeta.responsesnamespace, and TypeScript’sbetaResponsesSendstandalone function, keep working as deprecated aliases; their removal will be announced here with a sunset date before it ships.
- Migration: no action for HTTP clients. The Responses API is now GA.
- $.tags: beta.responses object removedNo action needed
- Same change as above at the specification level: the
beta.responsestag definition is gone from$.tags.
- Same change as above at the specification level: the
Modified endpoints
POST /responses: tags property_addedGET /byok: parameterproviderupdated
Modified schemas
-
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertyclaude-on-aws -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
-
BYOKProviderSlug: enum property_added
Schemas
Modified schemas
-
MessagesStartEvent: propertyproviderupdated- Used by
POST /messages
- Used by
-
ProviderName: enum property_added -
ProviderOptions: new propertyvoyageai -
ProviderResponse: enum property_added- Used by
GET /generation
- Used by
-
AnthropicCompactionBlock: new propertyencrypted_content- Used by
POST /messages
- Used by
-
MessagesToolAdditionBlock: new propertycache_control; new union variant added; type property_removedtoolwidened from a singletool_referenceobject to a union oftool_reference,mcp_tool_reference(name+server_name) andmcp_toolset_reference(server_name). Thetool_referencevariant is unchanged, so existing{ "type": "tool_reference", "name": "…" }payloads stay valid. Thenameandtypeproperties moved into that variant rather than being removed.- Used by
POST /messages,POST /presets/{slug}/messages
-
MessagesToolRemovalBlock: new propertycache_control; new union variant added; type property_removedtoolwidened the same way asMessagesToolAdditionBlock; existingtool_referencepayloads stay valid.- Used by
POST /messages,POST /presets/{slug}/messages
-
ORAnthropicStopReason: enum property_added- Used by
POST /messages
- Used by
Schemas
New schemas
ImageGenTextChunkEvent- Used by
POST /images
- Used by
Modified schemas
ImageStreamingResponse: new union variant added- Used by
POST /images
- Used by
DatasetsImagesModelsSTT
Modified endpoints
POST /audio/transcriptions: description updated; request body now acceptsmultipart/form-dataGET /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
sortupdated
- new parameter
New response codes
POST /images: now returns413
New schemas
STTSegment- Used by
POST /audio/transcriptions
- Used by
STTTimestampGranularity- Used by
POST /audio/transcriptions
- Used by
STTWord- Used by
POST /audio/transcriptions
- Used by
Modified schemas
-
ChatFunctionTool: new union variant added -
FusionServerToolConfig: description updated -
ImageGenCompletedEvent: description updated; example modified- Used by
POST /images
- Used by
-
ImageGenerationResponse: propertymedia_typeupdated- Used by
POST /images
- Used by
-
STTRequest: new propertyresponse_format; new propertytimestamp_granularities- Used by
POST /audio/transcriptions
- Used by
-
STTResponse:- new property
duration - new property
language - new property
segments - new property
task - new property
words - Used by
POST /audio/transcriptions
- new property
Workspaces
New endpoints
GET /workspaces/{id}/members: List workspace members
New schemas
ListWorkspaceMembersResponse- Used by
GET /workspaces/{id}/members
- Used by