OpenAI Content Provenance Checks API
The Content Provenance Checks API from OpenAI — 1 operation(s) for content provenance checks.
The Content Provenance Checks API from OpenAI — 1 operation(s) for content provenance checks.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/openai-content-provenance-checks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: OpenAI Content Provenance Checks API
description: The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
version: 2.3.0
termsOfService: https://openai.com/policies/terms-of-use
contact:
name: OpenAI Support
url: https://help.openai.com/
license:
name: MIT
identifier: MIT
servers:
- url: https://api.openai.com/v1
security:
- ApiKeyAuth: []
tags:
- name: Content Provenance Checks
paths:
/content_provenance_checks:
post:
summary: Create content provenance check
description: 'Check whether an image or audio file contains known OpenAI provenance signals. Learn more about content provenance.
If `not_detected`, it means the tool did not find supported signals in the uploaded file. The content could still have been generated by OpenAI if the metadata was stripped or has evidence of tampering, the watermark was degraded, it comes from a legacy generation model, or it was created before provenance signals were available. Content could also still be AI-generated by another company''s model, which the tool currently does not detect.'
operationId: Createcontentprovenancecheck
parameters: []
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateContentProvenanceBody'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ProvenanceResource'
'429':
$ref: '#/components/responses/TooManyRequests'
x-oaiMeta:
group: content_provenance_checks
examples: []
tags:
- Content Provenance Checks
components:
schemas:
ErrorResponse:
type: object
properties:
error:
$ref: '#/components/schemas/Error'
required:
- error
_MisalignmentErrorType:
anyOf:
- type: string
- type: string
enum:
- potentially_unintended_data_transfer
- potentially_unintended_data_access
- potentially_unintended_destructive_activity
- other
ProvenanceCheckObject:
type: string
enum:
- content_provenance_check
C2PAValidationStateApi:
type: string
enum:
- trusted
- valid
- invalid
- not_present
C2PAProvenanceResult:
properties:
type:
type: string
enum:
- c2pa
description: The provenance signal type. Always `c2pa`.
default: c2pa
x-stainless-const: true
outcome:
$ref: '#/components/schemas/ProvenanceDetectionResultApi'
description: 'Whether a supported OpenAI C2PA provenance signal was detected.
If `not_detected`, it means the tool did not find supported signals in the uploaded file. The content could still have been generated by OpenAI if the metadata was stripped or has evidence of tampering, the watermark was degraded, it comes from a legacy generation model, or it was created before provenance signals were available. Content could also still be AI-generated by another company''s model, which the tool currently does not detect.'
validation_state:
$ref: '#/components/schemas/C2PAValidationStateApi'
description: The validation status of the C2PA manifest in the uploaded image.
issuer:
anyOf:
- type: string
description: The C2PA manifest issuer, when available.
- type: 'null'
model:
anyOf:
- type: string
description: The OpenAI model recorded by the provenance signal, when available.
- type: 'null'
generated_at:
anyOf:
- type: string
description: The UTC RFC 3339 timestamp recorded by the provenance signal for when the asset was generated, when available.
- type: 'null'
type: object
required:
- type
- outcome
- validation_state
- issuer
- model
- generated_at
ProvenanceDetectionResultApi:
type: string
enum:
- detected
- not_detected
_MisalignmentSteer:
properties:
message:
type: string
description: The public continuation instruction.
type: object
required:
- message
SynthIDProvenanceResult:
properties:
type:
type: string
enum:
- synthid
description: The provenance signal type. Always `synthid`.
default: synthid
x-stainless-const: true
outcome:
$ref: '#/components/schemas/ProvenanceDetectionResultApi'
description: 'Whether a supported OpenAI SynthID watermark was detected.
If `not_detected`, it means the tool did not find supported signals in the uploaded file. The content could still have been generated by OpenAI if the metadata was stripped or has evidence of tampering, the watermark was degraded, it comes from a legacy generation model, or it was created before provenance signals were available. Content could also still be AI-generated by another company''s model, which the tool currently does not detect.'
model:
anyOf:
- type: string
description: The OpenAI model recorded by the provenance signal, when available.
- type: 'null'
generated_at:
anyOf:
- type: string
description: The UTC RFC 3339 timestamp recorded by the provenance signal for when the asset was generated, when available.
- type: 'null'
type: object
required:
- type
- outcome
- model
- generated_at
Error:
type: object
properties:
code:
anyOf:
- type: string
- type: 'null'
message:
type: string
param:
anyOf:
- type: string
- type: 'null'
type:
type: string
misalignment:
$ref: '#/components/schemas/MisalignmentErrorDetailsResource'
required:
- type
- message
- param
- code
CreateContentProvenanceBody:
properties:
file:
type: string
format: binary
description: The image or audio file to check for supported OpenAI provenance signals.
type: object
required:
- file
ProvenanceResource:
properties:
object:
$ref: '#/components/schemas/ProvenanceCheckObject'
description: The object type. Always `content_provenance_check` for this endpoint.
created_at:
type: integer
format: unixtime
description: The Unix timestamp, in seconds, when the provenance check was created.
results:
items:
oneOf:
- $ref: '#/components/schemas/C2PAProvenanceResult'
- $ref: '#/components/schemas/SynthIDProvenanceResult'
discriminator:
propertyName: type
type: array
description: The provenance results that apply to the uploaded file. Image results include C2PA and SynthID; audio results include SynthID.
type: object
required:
- object
- created_at
- results
MisalignmentErrorDetailsResource:
properties:
error_type:
$ref: '#/components/schemas/_MisalignmentErrorType'
description: An optional classification; clients must accept additional values.
detailed_explanation:
type: string
description: The public explanation for this block.
steer:
$ref: '#/components/schemas/_MisalignmentSteer'
description: An optional public continuation instruction.
type: object
required: []
responses:
TooManyRequests:
description: The request was rejected because a rate limit was exceeded.
headers:
Retry-After:
description: The minimum number of seconds to wait before retrying. This header is returned when the server has computed a retry delay and may be omitted for 429 responses that require user action.
schema:
type: integer
minimum: 1
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
AdminApiKeyAuth:
type: http
scheme: bearer
x-oaiMeta:
navigationGroups:
- id: responses
title: Responses API
- id: webhooks
title: Webhooks
- id: endpoints
title: Platform APIs
- id: vector_stores
title: Vector stores
- id: chatkit
title: ChatKit
beta: true
- id: containers
title: Containers
- id: live
title: Live (alpha)
- id: realtime
title: Realtime
- id: chat
title: Chat Completions
- id: assistants
title: Assistants
deprecated: true
- id: administration
title: Administration
- id: legacy
title: Legacy
groups:
- id: responses-streaming
title: Streaming events
description: 'When you [create a Response](https://developers.openai.com/api/reference/resources/responses/methods/create) with
`stream` set to `true`, the server will emit server-sent events to the
client as the Response is generated. This section contains the events that
are emitted by the server.
When processing a `compaction_trigger`, `response.compaction.compacting`
reports newly sampled summary output at most once every 30 seconds. It
carries no summary content and does not modify the compaction output item.
The existing `response.output_item.added` and `response.output_item.done`
events mark that item''s lifecycle; `response.output_item.done` carries its
final encrypted content. A short compaction may finish without emitting a
progress event.
[Learn more about streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses).
'
navigationGroup: responses
sections:
- type: object
key: ResponseCreatedEvent
path: <auto>
- type: object
key: ResponseInProgressEvent
path: <auto>
- type: object
key: ResponseCompletedEvent
path: <auto>
- type: object
key: ResponseFailedEvent
path: <auto>
- type: object
key: ResponseIncompleteEvent
path: <auto>
- type: object
key: ResponseOutputItemAddedEvent
path: <auto>
- type: object
key: ResponseOutputItemDoneEvent
path: <auto>
- type: object
key: ResponseCompactionCompactingEvent
path: <auto>
- type: object
key: ResponseContentPartAddedEvent
path: <auto>
- type: object
key: ResponseContentPartDoneEvent
path: <auto>
- type: object
key: ResponseTextDeltaEvent
path: response/output_text/delta
- type: object
key: ResponseTextDoneEvent
path: response/output_text/done
- type: object
key: ResponseRefusalDeltaEvent
path: <auto>
- type: object
key: ResponseRefusalDoneEvent
path: <auto>
- type: object
key: ResponseFunctionCallArgumentsDeltaEvent
path: <auto>
- type: object
key: ResponseFunctionCallArgumentsDoneEvent
path: <auto>
- type: object
key: ResponseFileSearchCallInProgressEvent
path: <auto>
- type: object
key: ResponseFileSearchCallSearchingEvent
path: <auto>
- type: object
key: ResponseFileSearchCallCompletedEvent
path: <auto>
- type: object
key: ResponseWebSearchCallInProgressEvent
path: <auto>
- type: object
key: ResponseWebSearchCallSearchingEvent
path: <auto>
- type: object
key: ResponseWebSearchCallCompletedEvent
path: <auto>
- type: object
key: ResponseReasoningSummaryPartAddedEvent
path: <auto>
- type: object
key: ResponseReasoningSummaryPartDoneEvent
path: <auto>
- type: object
key: ResponseReasoningSummaryTextDeltaEvent
path: <auto>
- type: object
key: ResponseReasoningSummaryTextDoneEvent
path: <auto>
- type: object
key: ResponseReasoningTextDeltaEvent
path: <auto>
- type: object
key: ResponseReasoningTextDoneEvent
path: <auto>
- type: object
key: ResponseImageGenCallCompletedEvent
path: <auto>
- type: object
key: ResponseImageGenCallGeneratingEvent
path: <auto>
- type: object
key: ResponseImageGenCallInProgressEvent
path: <auto>
- type: object
key: ResponseImageGenCallPartialImageEvent
path: <auto>
- type: object
key: ResponseMCPCallArgumentsDeltaEvent
path: <auto>
- type: object
key: ResponseMCPCallArgumentsDoneEvent
path: <auto>
- type: object
key: ResponseMCPCallCompletedEvent
path: <auto>
- type: object
key: ResponseMCPCallFailedEvent
path: <auto>
- type: object
key: ResponseMCPCallInProgressEvent
path: <auto>
- type: object
key: ResponseMCPListToolsCompletedEvent
path: <auto>
- type: object
key: ResponseMCPListToolsFailedEvent
path: <auto>
- type: object
key: ResponseMCPListToolsInProgressEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallInProgressEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallInterpretingEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallCompletedEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallCodeDeltaEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallCodeDoneEvent
path: <auto>
- type: object
key: ResponseOutputTextAnnotationAddedEvent
path: <auto>
- type: object
key: ResponseQueuedEvent
path: <auto>
- type: object
key: ResponseCustomToolCallInputDeltaEvent
path: <auto>
- type: object
key: ResponseCustomToolCallInputDoneEvent
path: <auto>
- type: object
key: ResponseErrorEvent
path: <auto>
- id: responses-websocket-client-events
title: Client events
description: 'Events sent by the client over a Responses API WebSocket connection.
'
navigationGroup: responses
sections:
- type: object
key: ResponsesClientEventResponseCreate
path: <auto>
- type: object
key: ResponseSteerEvent
path: <auto>
- id: responses-websocket-server-events
title: Server events (WebSocket only)
description: 'Events emitted only over a Responses API WebSocket connection.
'
navigationGroup: responses
sections:
- type: object
key: ResponseSteerAcceptedEvent
path: <auto>
- type: object
key: ResponseSteerPendingEvent
path: <auto>
- type: object
key: ResponseSteerFailedEvent
path: <auto>
- id: responses-websocket-shared-events
title: Server events
description: 'These events use the same payloads over WebSocket and
[HTTP streaming](https://developers.openai.com/api/reference/resources/responses/streaming-events).
Compaction progress follows the same cadence and output-item lifecycle
described in HTTP streaming.
'
navigationGroup: responses
sections:
- type: object
key: ResponseCreatedEvent
path: <auto>
- type: object
key: ResponseInProgressEvent
path: <auto>
- type: object
key: ResponseCompletedEvent
path: <auto>
- type: object
key: ResponseFailedEvent
path: <auto>
- type: object
key: ResponseIncompleteEvent
path: <auto>
- type: object
key: ResponseOutputItemAddedEvent
path: <auto>
- type: object
key: ResponseOutputItemDoneEvent
path: <auto>
- type: object
key: ResponseCompactionCompactingEvent
path: <auto>
- type: object
key: ResponseContentPartAddedEvent
path: <auto>
- type: object
key: ResponseContentPartDoneEvent
path: <auto>
- type: object
key: ResponseTextDeltaEvent
path: response/output_text/delta
- type: object
key: ResponseTextDoneEvent
path: response/output_text/done
- type: object
key: ResponseRefusalDeltaEvent
path: <auto>
- type: object
key: ResponseRefusalDoneEvent
path: <auto>
- type: object
key: ResponseFunctionCallArgumentsDeltaEvent
path: <auto>
- type: object
key: ResponseFunctionCallArgumentsDoneEvent
path: <auto>
- type: object
key: ResponseFileSearchCallInProgressEvent
path: <auto>
- type: object
key: ResponseFileSearchCallSearchingEvent
path: <auto>
- type: object
key: ResponseFileSearchCallCompletedEvent
path: <auto>
- type: object
key: ResponseWebSearchCallInProgressEvent
path: <auto>
- type: object
key: ResponseWebSearchCallSearchingEvent
path: <auto>
- type: object
key: ResponseWebSearchCallCompletedEvent
path: <auto>
- type: object
key: ResponseReasoningSummaryPartAddedEvent
path: <auto>
- type: object
key: ResponseReasoningSummaryPartDoneEvent
path: <auto>
- type: object
key: ResponseReasoningSummaryTextDeltaEvent
path: <auto>
- type: object
key: ResponseReasoningSummaryTextDoneEvent
path: <auto>
- type: object
key: ResponseReasoningTextDeltaEvent
path: <auto>
- type: object
key: ResponseReasoningTextDoneEvent
path: <auto>
- type: object
key: ResponseImageGenCallCompletedEvent
path: <auto>
- type: object
key: ResponseImageGenCallGeneratingEvent
path: <auto>
- type: object
key: ResponseImageGenCallInProgressEvent
path: <auto>
- type: object
key: ResponseImageGenCallPartialImageEvent
path: <auto>
- type: object
key: ResponseMCPCallArgumentsDeltaEvent
path: <auto>
- type: object
key: ResponseMCPCallArgumentsDoneEvent
path: <auto>
- type: object
key: ResponseMCPCallCompletedEvent
path: <auto>
- type: object
key: ResponseMCPCallFailedEvent
path: <auto>
- type: object
key: ResponseMCPCallInProgressEvent
path: <auto>
- type: object
key: ResponseMCPListToolsCompletedEvent
path: <auto>
- type: object
key: ResponseMCPListToolsFailedEvent
path: <auto>
- type: object
key: ResponseMCPListToolsInProgressEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallInProgressEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallInterpretingEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallCompletedEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallCodeDeltaEvent
path: <auto>
- type: object
key: ResponseCodeInterpreterCallCodeDoneEvent
path: <auto>
- type: object
key: ResponseOutputTextAnnotationAddedEvent
path: <auto>
- type: object
key: ResponseQueuedEvent
path: <auto>
- type: object
key: ResponseCustomToolCallInputDeltaEvent
path: <auto>
- type: object
key: ResponseCustomToolCallInputDoneEvent
path: <auto>
- type: object
key: ResponseErrorEvent
path: <auto>
- id: safety-cases
title: Safety Cases
description: 'Retrieve details about a safety warning or deactivation using the case ID
from a `safety.warning_issued` or `safety.deactivation_issued` webhook event.
Cases belong to an organization and require an API key with `api.safety.read`.
'
navigationGroup: endpoints
sections:
- type: endpoint
key: Getsafetycase
path: retrieve
- type: object
key: SafetyCaseResource
path: object
- id: safety-alerts
title: Safety Alerts
description: 'Retrieve approved safety alerts with an API key. Project keys require
`api.safety.alerts.read` and can read alerts from their project.
'
navigationGroup: endpoints
sections:
- type: endpoint
key: Getprojectsafetyalert
path: retrieve
- type: object
key: SafetyAlertResource
path: object
- id: webhook-events
title: Webhook Events
description: 'Webhooks are HTTP requests sent by OpenAI to a URL you specify when certain
events happen during the course of API usage.
[Learn more about webhooks](https://developers.openai.com/api/docs/guides/webhooks).
'
navigationGroup: webhooks
sections:
- type: object
key: WebhookResponseCompleted
path: <auto>
- type: object
key: WebhookResponseCancelled
path: <auto>
- type: object
key: WebhookResponseFailed
path: <auto>
- type: object
key: WebhookResponseIncomplete
path: <auto>
- type: object
key: WebhookBatchCompleted
path: <auto>
- type: object
key: WebhookBatchCancelled
path: <auto>
- type: object
key: WebhookBatchExpired
path: <auto>
- type: object
key: WebhookBatchFailed
path: <auto>
- type: object
key: WebhookFineTuningJobSucceeded
path: <auto>
- type: object
key: WebhookFineTuningJobFailed
path: <auto>
- type: object
key: WebhookFineTuningJobCancelled
path: <auto>
- type: object
key: WebhookEvalRunSucceeded
path: <auto>
- type: object
key: WebhookEvalRunFailed
path: <auto>
- type: object
key: WebhookEvalRunCanceled
path: <auto>
- type: object
key: WebhookRealtimeCallIncoming
path: <auto>
- type: object
key: WebhookLiveCallIncoming
path: <auto>
- type: object
key: WebhookLiveTransportIncoming
path: <auto>
- type: object
key: WebhookSafetyWarningIssued
path: <auto>
- type: object
key: WebhookSafetyDeactivationIssued
path: <auto>
- type: object
key: WebhookSafetyAlertCreated
path: <auto>
- type: object
key: WebhookSafetyOrgAlertCreated
path: <auto>
- id: images-streaming
title: Image Streaming
description: 'Stream image generation and editing in real time with server-sent events.
[Learn more about image streaming](https://developers.openai.com/api/docs/guides/image-generation).
'
navigationGroup: endpoints
sections:
- type: object
key: ImageGenPartialImageEvent
path: <auto>
- type: object
key: ImageGenCompletedEvent
path: <auto>
- type: object
key: ImageEditPartialImageEvent
path: <auto>
- type: object
key: ImageEditCompletedEvent
path: <auto>
- id: realtime-client-events
title: Client events
description: 'These are events that the OpenAI Realtime WebSocket server will accept from the client.
'
navigationGroup: realtime
sections:
- type: object
key: RealtimeClientEventSessionUpdate
path: <auto>
- type: object
key: RealtimeClientEventInputAudioBufferAppend
path: <auto>
- type: object
key: RealtimeClientEventInputAudioBufferCommit
path: <auto>
- type: object
key: RealtimeClientEventInputAudioBufferClear
path: <auto>
- type: object
key: RealtimeClientEventConversationItemCreate
path: <auto>
- type: object
key: RealtimeClientEventConversationItemRetrieve
path: <auto>
- type: object
key: RealtimeClientEventConversationItemTruncate
path: <auto>
- type: object
key: RealtimeClientEventConversationItemDelete
path: <auto>
- type: object
key: RealtimeClientEventResponseCreate
path: <auto>
- type: object
key: RealtimeClientEventResponseCancel
path: <auto>
- type: object
key: RealtimeClientEventOutputAudioBufferClear
path: <auto>
- id: realtime-server-events
title: Server events
description: 'These are events emitted from the OpenAI Realtime WebSocket server to the client.
'
navigationGroup: realtime
sections:
- type: object
key: RealtimeServerEventError
path: <auto>
- type: object
key: RealtimeServerEventSessionCreated
path: <auto>
- type: object
key: RealtimeServerEventSessionUpdated
path: <auto>
- type: object
key: RealtimeServerEventConversationItemAdded
path: <auto>
- type: object
key: RealtimeServerEventConversationItemDone
path: <auto>
- type: object
key: RealtimeServerEventConversationItemRetrieved
path: <auto>
- type: object
key: RealtimeServerEventConversationItemInputAudioTranscriptionCompleted
path: <auto>
- type: object
key: RealtimeServerEventConversationItemInputAudioTranscriptionDelta
path: <auto>
- type: object
key: RealtimeServerEventConversationItemInputAudioTranscriptionSegment
path: <auto>
- type: object
key: RealtimeServerEventConversationItemInputAudioTranscriptionFailed
path: <auto>
- type: object
key: RealtimeServerEventConversationItemTruncated
path: <auto>
- type: object
key: RealtimeServerEventConversationItemDeleted
path: <auto>
- type: object
key: RealtimeServerEventInputAudioBufferCommitted
path: <auto>
- type: object
key: RealtimeServerEventInputAudioBufferDtmfEventReceived
path: <auto>
- type: object
key: RealtimeServerEventInputAudioBufferCleared
path: <auto>
- type: object
key: RealtimeServerEventInputAudioBufferSpeechStarted
path: <auto>
- type: object
key: RealtimeServerEventInputAudioBufferSpeechStopped
path: <auto>
- type: object
key: RealtimeServerEventInputAudioBufferTimeoutTriggered
path: <auto>
- type: object
key: RealtimeServerEventOutputAudioBufferStarted
path: <auto>
- type: object
key: RealtimeServerEventOutputAudioBufferStopped
path: <auto>
- type: object
key: RealtimeServerEventOutputAudioBufferCleared
path: <auto>
- type: object
key: RealtimeServerEventResponseCreated
path: <auto>
- type: object
key: RealtimeServerEventResponseDone
path: <auto>
- type: object
key: RealtimeServerEventResponseOutputItemAdded
path: <auto>
- type: object
key: RealtimeServerEventResponseOutputItemDone
path: <auto>
- type: object
key: RealtimeServerEventResponseContentPartAdded
path: <auto>
- type: object
key: RealtimeServerEventResponseContentPartDone
path: <auto>
- type: object
key: RealtimeServerEventResponseTextDelta
path: <auto>
- type: object
key: RealtimeServerEventResponseTextDone
path: <auto>
- type: object
key: RealtimeServerEventResponseAudioTranscriptDelta
path: <auto>
- type: object
key: RealtimeServerEventResponseAudioTranscriptDone
path: <auto>
- type: object
key: RealtimeServerEventResponseAudioDelta
path: <auto>
- type: object
key: RealtimeServerEventResponseAudioDone
path: <auto>
- type: object
key: RealtimeServerEventResponseFunctionCallArgumentsDelta
path: <auto>
- type: object
key: RealtimeServerEventResponseFunctionCallArgumentsDone
path: <auto>
- type: object
key: RealtimeServerEventResponseMCPCallArgumentsDelta
path: <auto>
- type: object
key: RealtimeServerEventResponseMCPCallArgumentsDone
path: <auto>
- type: object
key: RealtimeServerEventResponseMCPCallInProgress
path: <auto>
- type: object
key: RealtimeServerEventResponseMCPCallCompleted
path: <auto>
- type: object
key: RealtimeServerEventResponseMCPCallFailed
path: <auto>
- type: object
key: RealtimeServerEventMCPListToolsInProgress
path: <auto>
- type: object
key: RealtimeServerEventMCPListToolsCompleted
path: <auto>
- type: object
key: RealtimeServerEventMCPListToolsFailed
path: <auto>
- type: object
key: RealtimeServerEventRateLimitsUpdated
path: <auto>
- id: realtime-translation-client-events
title: Translation client events
description: 'These are events that the OpenAI Realtime Translation WebSocket server will accept from the client.
'
navigationGroup: realtime
sections:
- type: object
key: RealtimeTranslationClientEventSessionUpdate
path: <auto>
- type: object
key: RealtimeTranslationClientEventInputAudioBufferAppend
path: <auto>
- type: object
key: RealtimeTranslationClientEventSessionClose
path: <auto>
- id: realtime-translation-server-events
title: Translation server events
description: 'These are events emitted from the OpenAI Realtime Translation WebSocket server to the client.
'
navigationGroup: realtime
sections:
- type: object
key: RealtimeServerEventError
path: <auto>
- type: object
key: RealtimeTranslationServerEventSessionCreated
path: <auto>
- type: object
key: RealtimeTranslationServerEventSessionUpdated
path: <auto>
- type: object
key: RealtimeTranslationServerEventSessionClosed
path: <auto>
- type: object
key: RealtimeTranslationServerEventSessionInputTranscriptDelta
path: <auto>
- type: object
key: RealtimeTranslationServerEventSessionOutputTranscriptDelta
path: <auto>
- type: object
key: RealtimeTranslationServerEventSessionOutputAudioDelta
path: <auto>
- id: chat-streaming
title: Streaming
description: 'Stream Chat Completions in real time. Receive chunks of completions
returned from the model using server-sent events.
[Learn more](https://developers.openai.com/api/docs/guides/streaming-responses).
'
navigationGroup: chat
sections:
- type: object
key: CreateChatCompletionStreamResponse
path: streaming
- id: assistants-streaming
title: Streaming
beta: true
description: 'Stream the result of executing a Run or resuming a Run after submitting tool outputs.
You can stream events from the [Create Thread and Run](https://developers.openai.com/api/docs/assistants/migration),
[Create Run](https://developers.openai.com/api/docs/assistants/migration), and [Submit Tool Outputs](https://developers.openai.com/api/docs/assistants/migration)
endpoints by passing `"stream": true`. The response will be a [Server-Sent events](https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events) stream.
Our Node and Python SDKs provide helpful utilities to make streaming easy. Reference the
[Assistants API quickstart](https://developers.openai.com/api/docs/assistants/migration) to learn more.
'
navigationGroup: assistants
sections:
- type: object
key: AssistantStreamEvent
path: events
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openai/refs/heads/main/openapi/openai-content-provenance-checks-api-openapi.yml