Sign in

v1

latestOpenAPI 3.0.32026-07-26289.0 KB

Get response

Processes a message using the specified API integration and returns a response from the agent. Requires a valid platform token. Ensure the apiIntegrationId is valid. Supports continuing existing chats via chatId or aliasChatId and attaching files with tools.

post/get_response

Request body

messagestring required

The message content to be processed by the agent. Example: "Hey! How are you?"

apiIntegrationIdstring required

The unique identifier for the API integration being used. Example: "dpCD7snQ0tCWrdtp6UhZ"

chatIdstring nullable

The unique identifier for the chat session. If provided, continues the chat with the previous context. Example: "plOQeH3hW7UKiACqEdAx"

additionalInstructionsstring nullable

Appends additional instructions at the end of the agent's instructions for the run. Useful for modifying behavior per-run. Example: "User name: John Smith"

aliasChatIdstring nullable

An alternative to chatId which allows using custom identifiers for persisting chats through third party integrations. Example: "custom-identifier"

Response

Successful response. The format varies depending on the textOnly mode configured for the API Integration. If textOnly is enabled, the response is plain text. Otherwise, it's application/json.

chatIdstring

The unique identifier for the chat session. Example: "FVfA971B3fnBH4S1OKlo"

createdAtstring date-time

The timestamp when the response was created (ISO 8601 format). Example: "2024-08-06T02:02:37.533913"

threadIdstring

The unique identifier for the underlying thread. Example: "thread_ruUj69CyW2STm8Zog0HXkvIJ"

assistantIdstring

The unique identifier for the assistant that responded. Example: "J3NQwdHxqm9jvWFpOwFk"

namestring

The name of the API integration used. Example: "Test API Integration"

numMessagesinteger

The total number of messages in the chat thread. Example: 2

aliasChatIdstring

Alternative chat identifier used for persisting chats through third party integrations. Example: "r14ud3CyX21Tm8Zog0HKJkvZJ"