Loading...
Skip to main content

Send Message

Send Message

Path Parameters
    agentId string required
    conversationId string required
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

OK


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

    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.

  • ]
  • 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.

Loading...