Skip to main content
Section ID: DOC-API-MODEL-schema-q69v86pv94#overview

ReceiveMessageRequest

Receives a new message event (e.g., from the generation workflow)

Type-reference view: API Schema 9frhv4euve. Request and response views describe this type; they do not declare an endpoint.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-q69v86pv94#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-q69v86pv94#fields

UsageFields and validation
In requestsView fields
In responsesView fields

In requests​

Section ID: DOC-API-MODEL-schema-q69v86pv94#request

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-q69v86pv94#request-field-messagemessageMessageOptionalThe message to append (assistant/tool/system)

In responses​

Section ID: DOC-API-MODEL-schema-q69v86pv94#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-q69v86pv94#field-messageSection ID: DOC-API-MODEL-schema-q69v86pv94#response-field-messagemessageMessageOptionalThe message to append (assistant/tool/system)

Where used​

Section ID: DOC-API-MODEL-schema-q69v86pv94#where-used

ReferenceRelationship
ReceiveMessageRequestAPI JSON uses JSON field names (camelCase).

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-q69v86pv94