DOC-API-MODEL-schema-q7hl8fcm9r#overview
ConversationBranch
Conversation branching
Type-reference view: API Schema 626klhca0u. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#request-field-branchidbranchId | string | Optional | Identifier of the conversation branch. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#request-field-branchnamebranchName | string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#request-field-frommessageidfromMessageId | string | Optional | Identifier of the message from which the conversation branch diverged. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#request-field-messageidsmessageIds | Array of string | Optional | Message identifiers associated with this conversation branch. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#request-field-metadatametadata | BranchMetadata | Optional | Reason, labels, and quality metadata for this conversation branch. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#request-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#request-field-isactiveisActive | boolean | Optional | Whether this conversation branch is marked active. |
branchName
Name distinguishing this alternative branch of the conversation.
"alternative_approach", "retry_attempt"
In responses
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#field-branchidSection ID: DOC-API-MODEL-schema-q7hl8fcm9r#response-field-branchidbranchId | string | Optional | Identifier of the conversation branch. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#field-branchnameSection ID: DOC-API-MODEL-schema-q7hl8fcm9r#response-field-branchnamebranchName | string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#field-frommessageidSection ID: DOC-API-MODEL-schema-q7hl8fcm9r#response-field-frommessageidfromMessageId | string | Optional | Identifier of the message from which the conversation branch diverged. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#field-messageidsSection ID: DOC-API-MODEL-schema-q7hl8fcm9r#response-field-messageidsmessageIds | Array of string | Optional | Message identifiers associated with this conversation branch. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#field-metadataSection ID: DOC-API-MODEL-schema-q7hl8fcm9r#response-field-metadatametadata | BranchMetadata | Optional | Reason, labels, and quality metadata for this conversation branch. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#field-createdatSection ID: DOC-API-MODEL-schema-q7hl8fcm9r#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#field-isactiveSection ID: DOC-API-MODEL-schema-q7hl8fcm9r#response-field-isactiveisActive | boolean | Optional | Whether this conversation branch is marked active. |
branchName
Name distinguishing this alternative branch of the conversation.
"alternative_approach", "retry_attempt"
Where used
Section ID: DOC-API-MODEL-schema-q7hl8fcm9r#where-used
| Reference | Relationship |
|---|---|
| ConversationBranch | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-q7hl8fcm9r