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
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
background | boolean | Optional | Constrained | Must be false. |
context_ | null | Optional | Disabled | Omit or null. |
conversation | null | Optional | Disabled | Omit or null. |
include | null | Optional | Disabled | Omit or null. |
input | string | Required | Guarded | At least 1 character. |
instructions | null | Optional | Disabled | Omit or null. |
max_ | any | Optional | Opaque | Provider requirements apply. |
max_ | any | Optional | Opaque | Provider requirements apply. |
metadata | any | Optional | Opaque | Provider requirements apply. |
model | any | Optional | Opaque | Provider requirements apply. |
moderation | any | Optional | Opaque | Provider requirements apply. |
parallel_ | any | Optional | Opaque | Provider requirements apply. |
previous_ | null | Optional | Disabled | Omit or null. |
prompt | null | Optional | Disabled | Omit or null. |
prompt_ | any | Optional | Opaque | Provider requirements apply. |
prompt_ | object or null | Optional | Constrained | If non-null, see nested fields. |
prompt_ | any | Optional | Opaque | Provider requirements apply. |
reasoning | object or null | Optional | Constrained | If non-null, see nested fields. |
safety_ | any | Optional | Opaque | Provider requirements apply. |
service_ | any | Optional | Opaque | Provider requirements apply. |
store | boolean | Required | Constrained | Must be false. |
stream | boolean | Optional | Constrained | See exact contract. |
stream_ | any | Optional | Opaque | Provider requirements apply. |
temperature | any | Optional | Opaque | Provider requirements apply. |
text | object or null | Optional | Constrained | If non-null, see nested fields. |
tool_ | null | Optional | Disabled | Omit or null. |
tools | null | Optional | Disabled | Omit or null. |
top_ | integer or null | Optional | Constrained | If non-null, must be 0. |
top_ | any | Optional | Opaque | Provider requirements apply. |
truncation | any | Optional | Opaque | Provider requirements apply. |
user | any | Optional | Opaque | Provider requirements apply. |
Object policy
model: ResponsesGuardedRequestreject_case_aliases: truesource: '#/components/schemas/CreateResponse'stream_selector_field: streamunknown_fields: forbid
$.prompt_cache_options (oneOf branch 1)
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
comparison_ | any | Optional | Opaque | Provider requirements apply. |
mode | any | Optional | Opaque | Provider requirements apply. |
prewarm | boolean | Optional | Constrained | Must be false. |
ttl | any | Optional | Opaque | Provider requirements apply. |
Object policy
reject_case_aliases: truesource: '#/components/schemas/ResponsePromptCacheOptionsParam'unknown_fields: forbid
$.reasoning (oneOf branch 1)
Object policy
reject_case_aliases: truesource: '#/components/schemas/Reasoning'unknown_fields: configurable
$.text (oneOf branch 1)
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
format | object or null | Optional | Constrained | If non-null, see nested fields. |
verbosity | any | Optional | Opaque | Provider requirements apply. |
Object policy
reject_case_aliases: truesource: '#/components/schemas/ResponseTextParam'unknown_fields: configurable
$.text (oneOf branch 1).format (oneOf branch 1)
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
type | string | Required | Constrained | Must be "text". |
Object policy
reject_case_aliases: truesource: '#/components/schemas/ResponseFormatText'unknown_fields: configurable
Response
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
access_ | any | Optional | Opaque | Provider requirements apply. |
background | any | Optional | Opaque | Provider requirements apply. |
billing | any | Optional | Opaque | Provider requirements apply. |
completed_ | any | Optional | Opaque | Provider requirements apply. |
conversation | any | Optional | Opaque | Provider requirements apply. |
created_ | any | Optional | Opaque | Provider requirements apply. |
error | any | Optional | Opaque | Provider requirements apply. |
frequency_ | any | Optional | Opaque | Provider requirements apply. |
id | any | Optional | Opaque | Provider requirements apply. |
image | object or null | Optional | Constrained | If non-null, see nested fields. |
incomplete_ | any | Optional | Opaque | Provider requirements apply. |
input_ | array or null | Optional | Constrained | If non-null, see nested fields. |
instructions | any | Optional | Opaque | Provider requirements apply. |
max_ | any | Optional | Opaque | Provider requirements apply. |
max_ | any | Optional | Opaque | Provider requirements apply. |
metadata | any | Optional | Opaque | Provider requirements apply. |
model | any | Optional | Opaque | Provider requirements apply. |
moderation | any | Optional | Opaque | Provider requirements apply. |
object | any | Optional | Opaque | Provider requirements apply. |
output | array | Required | Guarded | See nested fields. |
output_ | null | Optional | Disabled | Omit or null. |
parallel_ | any | Optional | Opaque | Provider requirements apply. |
presence_ | any | Optional | Opaque | Provider requirements apply. |
previous_ | any | Optional | Opaque | Provider requirements apply. |
prompt | any | Optional | Opaque | Provider requirements apply. |
prompt_ | any | Optional | Opaque | Provider requirements apply. |
prompt_ | any | Optional | Opaque | Provider requirements apply. |
prompt_ | any | Optional | Opaque | Provider requirements apply. |
prompt_ | any | Optional | Opaque | Provider requirements apply. |
reasoning | any | Optional | Opaque | Provider requirements apply. |
safety_ | any | Optional | Opaque | Provider requirements apply. |
service_ | any | Optional | Opaque | Provider requirements apply. |
status | any | Optional | Opaque | Provider requirements apply. |
store | any | Optional | Opaque | Provider requirements apply. |
temperature | any | Optional | Opaque | Provider requirements apply. |
text | any | Optional | Opaque | Provider requirements apply. |
tool_ | any | Optional | Opaque | Provider requirements apply. |
tool_ | any | Optional | Opaque | Provider requirements apply. |
tools | any | Optional | Opaque | Provider requirements apply. |
top_ | any | Optional | Opaque | Provider requirements apply. |
top_ | any | Optional | Opaque | Provider requirements apply. |
truncation | any | Optional | Opaque | Provider requirements apply. |
usage | any | Optional | Opaque | Provider requirements apply. |
user | any | Optional | Opaque | Provider requirements apply. |
Object policy
model: ResponsesGuardedResponsereject_case_aliases: truesource: '#/components/schemas/Response'unknown_fields: forbid
$.image (oneOf branch 1)
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
context_ | string | Required | Constrained | Allowed: "enabled", "disabled". |
Object policy
reject_case_aliases: truesource: '#/components/schemas/ResolvedImageOptions'unknown_fields: forbid
$.input_transformations (oneOf branch 1)[]
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
action | string | Required | Constrained | Must be "removed". |
id | string | Required | Constrained | See exact contract. |
reason | string | Required | Constrained | Allowed: "organization_mismatch", "end_user_mismatch", "model_mismatch", "prefix_mismatch", "turn_boundary". |
type | string | Required | Constrained | Must be "reasoning". |
Object policy
reject_case_aliases: truesource: '#/components/schemas/InputTransformation'unknown_fields: forbid
$.output[] (oneOf branch 1)
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
content | array or null | Optional | Constrained | If non-null, at most 0 items. See nested fields. |
encrypted_ | any | Optional | Opaque | Provider requirements apply. |
id | any | Optional | Opaque | Provider requirements apply. |
status | any | Optional | Opaque | Provider requirements apply. |
summary | array or null | Optional | Constrained | If non-null, at most 0 items. See nested fields. |
type | string | Required | Constrained | Must be "reasoning". |
Object policy
reject_case_aliases: truesource: '#/components/schemas/ReasoningItem'unknown_fields: configurablevariant:cardinality: anymatch:type: reasoning
$.output[] (oneOf branch 2)
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
content | array | Required | Guarded | Exactly 1 item. See nested fields. |
id | any | Optional | Opaque | Provider requirements apply. |
phase | any | Optional | Opaque | Provider requirements apply. |
role | string | Required | Constrained | Must be "assistant". |
status | any | Optional | Opaque | Provider requirements apply. |
type | string | Required | Constrained | Must be "message". |
Object policy
reject_case_aliases: truesource: '#/components/schemas/OutputMessage'unknown_fields: configurablevariant:cardinality: exactly_onematch:role: assistanttype: message
$.output[] (oneOf branch 2).content[]
| Field | Type | Presence | Policy | Rules |
|---|---|---|---|---|
annotations | array or null | Optional | Constrained | If non-null, at most 0 items. See nested fields. |
logprobs | array or null | Optional | Constrained | If non-null, at most 0 items. See nested fields. |
text | string | Required | Guarded | At least 1 character. |
type | string | Required | Constrained | Must be "output_text". |
Object policy
reject_case_aliases: truesource: '#/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.
| Shape | Role | Text subjects | Missing text | Selection |
|---|---|---|---|---|
response.output_text.delta | guarded_delta | $.delta | {"missing_text": "reject"} | {"match": {"type": "response.output_text.delta"}, "source_schema": "ResponseTextDeltaEvent"} |
response.output_text.done | snapshot | $.text | {"missing_text": "reject"} | {"match": {"type": "response.output_text.done"}, "source_schema": "ResponseTextDoneEvent"} |
response.content_part.added | snapshot | $.part.text | {"missing_text": "reject"} | {"match": {"type": "response.content_part.added"}, "source_schema": "ResponseContentPartAddedEvent"} |
response.content_part.done | snapshot | $.part.text | {"missing_text": "reject"} | {"match": {"type": "response.content_part.done"}, "source_schema": "ResponseContentPartDoneEvent"} |
response.output_item.added:message | snapshot | $.item.content[].text | {"missing_text": "empty"} | {"match": {"item.type": "message", "type": "response.output_item.added"}, "source_schema": "ResponseOutputItemAddedEvent"} |
response.output_item.done:message | snapshot | $.item.content[].text | {"missing_text": "empty"} | {"match": {"item.type": "message", "type": "response.output_item.done"}, "source_schema": "ResponseOutputItemDoneEvent"} |
response.created | snapshot | $.response.output[] (oneOf branch 2).content[].text | {"missing_text": "empty"} | {"match": {"type": "response.created"}, "source_schema": "ResponseCreatedEvent"} |
response.in_progress | snapshot | $.response.output[] (oneOf branch 2).content[].text | {"missing_text": "empty"} | {"match": {"type": "response.in_progress"}, "source_schema": "ResponseInProgressEvent"} |
response.queued | snapshot | $.response.output[] (oneOf branch 2).content[].text | {"missing_text": "empty"} | {"match": {"type": "response.queued"}, "source_schema": "ResponseQueuedEvent"} |
response.completed | snapshot | $.response.output[] (oneOf branch 2).content[].text | {"missing_text": "empty"} | {"match": {"type": "response.completed"}, "source_schema": "ResponseCompletedEvent"} |
response.failed | snapshot | $.response.output[] (oneOf branch 2).content[].text | {"missing_text": "empty"} | {"match": {"type": "response.failed"}, "source_schema": "ResponseFailedEvent"} |
response.incomplete | snapshot | $.response.output[] (oneOf branch 2).content[].text | {"missing_text": "empty"} | {"match": {"type": "response.incomplete"}, "source_schema": "ResponseIncompleteEvent"} |
response.output_item.added:reasoning | opaque | — | — | {"match": {"item.type": "reasoning", "type": "response.output_item.added"}, "source_schema": "ResponseOutputItemAddedEvent"} |
response.output_item.done:reasoning | opaque | — | — | {"match": {"item.type": "reasoning", "type": "response.output_item.done"}, "source_schema": "ResponseOutputItemDoneEvent"} |
error | provider_error | — | — | {"match": {"type": "error"}, "source_schema": "ResponseErrorEvent"} |
Transport declarations
transport:data_discriminator: typenon_data_shape: keepaliverequire_sse_event: falsesentinels:'[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.