Skip to navigation

OpenAI Responses Guard Contract

View as MarkdownOpen in Claude

API reference · Field-policy meanings

Operation: createResponse. Payload profile: single_text.v1. Contract format: 1.0.0-alpha.1.

Request · Response · Stream · Exact contract

These declarations describe the native binding’s guard boundary, not a complete provider schema. Rails configuration selects the checks that run. See supported content.

Response and stream inspection declarations apply when output inspection is enabled. Guarded request validation still applies when checks are disabled. See disabled checks and pass-through.

Required presence is local to each containing object and schema branch. Nested accordions preserve those scopes; branch labels identify schema alternatives, not payload members. Hover a field name for its exact schema pointer. Defaults are not inserted into forwarded traffic.

Request

FieldTypePresencePolicyRules
backgroundbooleanOptionalConstrainedMust be false.
context_managementnullOptionalDisabledOmit or null.
conversationnullOptionalDisabledOmit or null.
includenullOptionalDisabledOmit or null.
inputstringRequiredGuardedAt least 1 character.
instructionsnullOptionalDisabledOmit or null.
max_output_tokensanyOptionalOpaqueProvider requirements apply.
max_tool_callsanyOptionalOpaqueProvider requirements apply.
metadataanyOptionalOpaqueProvider requirements apply.
modelanyOptionalOpaqueProvider requirements apply.
moderationanyOptionalOpaqueProvider requirements apply.
parallel_tool_callsanyOptionalOpaqueProvider requirements apply.
previous_response_idnullOptionalDisabledOmit or null.
promptnullOptionalDisabledOmit or null.
prompt_cache_keyanyOptionalOpaqueProvider requirements apply.
prompt_cache_optionsobject or nullOptionalConstrainedIf non-null, see nested fields.
prompt_cache_retentionanyOptionalOpaqueProvider requirements apply.
reasoningobject or nullOptionalConstrainedIf non-null, see nested fields.
safety_identifieranyOptionalOpaqueProvider requirements apply.
service_tieranyOptionalOpaqueProvider requirements apply.
storebooleanRequiredConstrainedMust be false.
streambooleanOptionalConstrainedSee exact contract.
stream_optionsanyOptionalOpaqueProvider requirements apply.
temperatureanyOptionalOpaqueProvider requirements apply.
textobject or nullOptionalConstrainedIf non-null, see nested fields.
tool_choicenullOptionalDisabledOmit or null.
toolsnullOptionalDisabledOmit or null.
top_logprobsinteger or nullOptionalConstrainedIf non-null, must be 0.
top_panyOptionalOpaqueProvider requirements apply.
truncationanyOptionalOpaqueProvider requirements apply.
useranyOptionalOpaqueProvider requirements apply.
model: ResponsesGuardedRequest
reject_case_aliases: true
source: '#/components/schemas/CreateResponse'
stream_selector_field: stream
unknown_fields: forbid
FieldTypePresencePolicyRules
comparison_response_idanyOptionalOpaqueProvider requirements apply.
modeanyOptionalOpaqueProvider requirements apply.
prewarmbooleanOptionalConstrainedMust be false.
ttlanyOptionalOpaqueProvider requirements apply.
reject_case_aliases: true
source: '#/components/schemas/ResponsePromptCacheOptionsParam'
unknown_fields: forbid
FieldTypePresencePolicyRules
contextnullOptionalDisabledOmit or null.
effortanyOptionalOpaqueProvider requirements apply.
generate_summarynullOptionalDisabledOmit or null.
modenullOptionalDisabledOmit or null.
summarynullOptionalDisabledOmit or null.
reject_case_aliases: true
source: '#/components/schemas/Reasoning'
unknown_fields: configurable
FieldTypePresencePolicyRules
formatobject or nullOptionalConstrainedIf non-null, see nested fields.
verbosityanyOptionalOpaqueProvider requirements apply.
reject_case_aliases: true
source: '#/components/schemas/ResponseTextParam'
unknown_fields: configurable
FieldTypePresencePolicyRules
typestringRequiredConstrainedMust be "text".
reject_case_aliases: true
source: '#/components/schemas/ResponseFormatText'
unknown_fields: configurable

Response

FieldTypePresencePolicyRules
access_programsanyOptionalOpaqueProvider requirements apply.
backgroundanyOptionalOpaqueProvider requirements apply.
billinganyOptionalOpaqueProvider requirements apply.
completed_atanyOptionalOpaqueProvider requirements apply.
conversationanyOptionalOpaqueProvider requirements apply.
created_atanyOptionalOpaqueProvider requirements apply.
erroranyOptionalOpaqueProvider requirements apply.
frequency_penaltyanyOptionalOpaqueProvider requirements apply.
idanyOptionalOpaqueProvider requirements apply.
imageobject or nullOptionalConstrainedIf non-null, see nested fields.
incomplete_detailsanyOptionalOpaqueProvider requirements apply.
input_transformationsarray or nullOptionalConstrainedIf non-null, see nested fields.
instructionsanyOptionalOpaqueProvider requirements apply.
max_output_tokensanyOptionalOpaqueProvider requirements apply.
max_tool_callsanyOptionalOpaqueProvider requirements apply.
metadataanyOptionalOpaqueProvider requirements apply.
modelanyOptionalOpaqueProvider requirements apply.
moderationanyOptionalOpaqueProvider requirements apply.
objectanyOptionalOpaqueProvider requirements apply.
outputarrayRequiredGuardedSee nested fields.
output_textnullOptionalDisabledOmit or null.
parallel_tool_callsanyOptionalOpaqueProvider requirements apply.
presence_penaltyanyOptionalOpaqueProvider requirements apply.
previous_response_idanyOptionalOpaqueProvider requirements apply.
promptanyOptionalOpaqueProvider requirements apply.
prompt_cache_diagnosticsanyOptionalOpaqueProvider requirements apply.
prompt_cache_keyanyOptionalOpaqueProvider requirements apply.
prompt_cache_optionsanyOptionalOpaqueProvider requirements apply.
prompt_cache_retentionanyOptionalOpaqueProvider requirements apply.
reasoninganyOptionalOpaqueProvider requirements apply.
safety_identifieranyOptionalOpaqueProvider requirements apply.
service_tieranyOptionalOpaqueProvider requirements apply.
statusanyOptionalOpaqueProvider requirements apply.
storeanyOptionalOpaqueProvider requirements apply.
temperatureanyOptionalOpaqueProvider requirements apply.
textanyOptionalOpaqueProvider requirements apply.
tool_choiceanyOptionalOpaqueProvider requirements apply.
tool_usageanyOptionalOpaqueProvider requirements apply.
toolsanyOptionalOpaqueProvider requirements apply.
top_logprobsanyOptionalOpaqueProvider requirements apply.
top_panyOptionalOpaqueProvider requirements apply.
truncationanyOptionalOpaqueProvider requirements apply.
usageanyOptionalOpaqueProvider requirements apply.
useranyOptionalOpaqueProvider requirements apply.
model: ResponsesGuardedResponse
reject_case_aliases: true
source: '#/components/schemas/Response'
unknown_fields: forbid
FieldTypePresencePolicyRules
context_compressionstringRequiredConstrainedAllowed: "enabled", "disabled".
reject_case_aliases: true
source: '#/components/schemas/ResolvedImageOptions'
unknown_fields: forbid
FieldTypePresencePolicyRules
actionstringRequiredConstrainedMust be "removed".
idstringRequiredConstrainedSee exact contract.
reasonstringRequiredConstrainedAllowed: "organization_mismatch", "end_user_mismatch", "model_mismatch", "prefix_mismatch", "turn_boundary".
typestringRequiredConstrainedMust be "reasoning".
reject_case_aliases: true
source: '#/components/schemas/InputTransformation'
unknown_fields: forbid
FieldTypePresencePolicyRules
contentarray or nullOptionalConstrainedIf non-null, at most 0 items. See nested fields.
encrypted_contentanyOptionalOpaqueProvider requirements apply.
idanyOptionalOpaqueProvider requirements apply.
statusanyOptionalOpaqueProvider requirements apply.
summaryarray or nullOptionalConstrainedIf non-null, at most 0 items. See nested fields.
typestringRequiredConstrainedMust be "reasoning".
reject_case_aliases: true
source: '#/components/schemas/ReasoningItem'
unknown_fields: configurable
variant:
cardinality: any
match:
type: reasoning
FieldTypePresencePolicyRules
contentarrayRequiredGuardedExactly 1 item. See nested fields.
idanyOptionalOpaqueProvider requirements apply.
phaseanyOptionalOpaqueProvider requirements apply.
rolestringRequiredConstrainedMust be "assistant".
statusanyOptionalOpaqueProvider requirements apply.
typestringRequiredConstrainedMust be "message".
reject_case_aliases: true
source: '#/components/schemas/OutputMessage'
unknown_fields: configurable
variant:
cardinality: exactly_one
match:
role: assistant
type: message
FieldTypePresencePolicyRules
annotationsarray or nullOptionalConstrainedIf non-null, at most 0 items. See nested fields.
logprobsarray or nullOptionalConstrainedIf non-null, at most 0 items. See nested fields.
textstringRequiredGuardedAt least 1 character.
typestringRequiredConstrainedMust be "output_text".
reject_case_aliases: true
source: '#/components/schemas/OutputTextContent'
unknown_fields: configurable

Stream

Event roles and missing-text rules come from the bound classifier. See stream declaration meanings and runtime completion and errors.

ShapeRoleText subjectsMissing textSelection
response.output_text.deltaguarded_delta$.delta{"missing_text": "reject"}{"match": {"type": "response.output_text.delta"}, "source_schema": "ResponseTextDeltaEvent"}
response.output_text.donesnapshot$.text{"missing_text": "reject"}{"match": {"type": "response.output_text.done"}, "source_schema": "ResponseTextDoneEvent"}
response.content_part.addedsnapshot$.part.text{"missing_text": "reject"}{"match": {"type": "response.content_part.added"}, "source_schema": "ResponseContentPartAddedEvent"}
response.content_part.donesnapshot$.part.text{"missing_text": "reject"}{"match": {"type": "response.content_part.done"}, "source_schema": "ResponseContentPartDoneEvent"}
response.output_item.added:messagesnapshot$.item.content[].text{"missing_text": "empty"}{"match": {"item.type": "message", "type": "response.output_item.added"}, "source_schema": "ResponseOutputItemAddedEvent"}
response.output_item.done:messagesnapshot$.item.content[].text{"missing_text": "empty"}{"match": {"item.type": "message", "type": "response.output_item.done"}, "source_schema": "ResponseOutputItemDoneEvent"}
response.createdsnapshot$.response.output[] (oneOf branch 2).content[].text{"missing_text": "empty"}{"match": {"type": "response.created"}, "source_schema": "ResponseCreatedEvent"}
response.in_progresssnapshot$.response.output[] (oneOf branch 2).content[].text{"missing_text": "empty"}{"match": {"type": "response.in_progress"}, "source_schema": "ResponseInProgressEvent"}
response.queuedsnapshot$.response.output[] (oneOf branch 2).content[].text{"missing_text": "empty"}{"match": {"type": "response.queued"}, "source_schema": "ResponseQueuedEvent"}
response.completedsnapshot$.response.output[] (oneOf branch 2).content[].text{"missing_text": "empty"}{"match": {"type": "response.completed"}, "source_schema": "ResponseCompletedEvent"}
response.failedsnapshot$.response.output[] (oneOf branch 2).content[].text{"missing_text": "empty"}{"match": {"type": "response.failed"}, "source_schema": "ResponseFailedEvent"}
response.incompletesnapshot$.response.output[] (oneOf branch 2).content[].text{"missing_text": "empty"}{"match": {"type": "response.incomplete"}, "source_schema": "ResponseIncompleteEvent"}
response.output_item.added:reasoningopaque——{"match": {"item.type": "reasoning", "type": "response.output_item.added"}, "source_schema": "ResponseOutputItemAddedEvent"}
response.output_item.done:reasoningopaque——{"match": {"item.type": "reasoning", "type": "response.output_item.done"}, "source_schema": "ResponseOutputItemDoneEvent"}
errorprovider_error——{"match": {"type": "error"}, "source_schema": "ResponseErrorEvent"}

Transport declarations

transport:
data_discriminator: type
non_data_shape: keepalive
require_sse_event: false
sentinels:
'[DONE]': done

Exact contract

This is the unmodified export from the bound Python endpoint. Stateful stream hooks, enabled Rails checks, and arbitrary Python validation are not serialized.