Send Message

Send Message

Path Parameters

agentId string required
conversationId string required

application/json

Request Body required

message string

The message to send in the conversation.

metadata object

Metadata to associate with the message.

runtimeParameters object

Parameters for the agent's runtime. Must conform to the JSON schema required by the runtime. Will override any runtime parameters that were used when creating the conversation.

Responses

• 200
• 429

---

OK

application/jsonl

Schema

Example (from schema)

---

Schema

id string required

The unique ID of the message.

timestamp date-time required

The time the message was sent.

role enum required

Possible values: [user, assistant]

The sender of the message. Messages sent via the API are user messages; messages generated by an agent are assistant messages.

messages object[] required
The typed message fragments.
Array [
anyOf
TextMessageFragment
FunctionCallMessageFragment
FunctionResponseMessageFragment
---
kind string required
Possible values: [text]
content string required
The message text.
state string
Possible values: [in-progress, done]
Indicates whether content within this fragment is still streaming. Note that this may be in-progress even if message-level state is not, which indicates that this particular fragment was incomplete at the time the message generation stopped.
metadata object
Additional user- or agent-provided metadata.
kind string required
Possible values: [functionCall]
name string required
The name of the function that was requested.
args object
The arguments of the requested function call.
metadata object
Additional user- or agent-provided metadata.
kind string required
Possible values: [functionResponse]
name string required
The name of the function that was invoked.
response string
The result of invoking the function.
failed boolean
Indicates whether the function invocation failed.
metadata object
Additional user- or agent-provided metadata.
]
state enum required

Possible values: [in-progress, done, stopped, error]

For agent-generated messages, indicates the status of the generation. User-sent messages are always done.

errorDetail string

Indicates details of the error for agent-generated messages in the error state.

inReplyToId string

For agent-generated messages, indicates the user message that the message was in reply to.

{
  "id": "string",
  "timestamp": "2024-03-07T22:56:08.579Z",
  "role": "user",
  "messages": [
    {
      "kind": "text",
      "content": "Hello!"
    },
    {
      "kind": "functionCall",
      "name": "queryKnowledgeBase",
      "args": {
        "query": "Why is the sky blue?"
      }
    },
    {
      "kind": "functionResponse",
      "name": "queryKnowledgeBase",
      "response": "{\n  \"kind\": \"docs\",\n  \"results\": []\n}"
    }
  ],
  "state": "in-progress",
  "errorDetail": "string",
  "inReplyToId": "string"
}

Query limit exceeded.

Loading...