Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Agent Sessions

Interact with an agent

Creates a new input event in the session to interact with the agent.

post/v2/agents/{agent_key}/sessions/{session_key}/events

Path parameters

agent_keystring required

A unique key that identifies an agent.

Example:customer_support

The unique identifier of the agent.

session_keystring required

A unique key that identifies an agent session.

Example:customer_support_chat

The unique key of the session to create an input in.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

OR
OR
OR

Example request

{
  "surface_description": {
    "type": "slack",
    "id": "con_slack_support"
  },
  "messages": [
    {
      "type": "text",
      "content": "I need help with my widget installation"
    }
  ],
  "since": "start",
  "entry_step": "triage"
}

Response

The input event is created.

session_keystring required

A unique key that identifies an agent session.

Example response

{
  "events": [
    {
      "id": "aev_user_001",
      "session_key": "customer_support_chat",
      "created_at": "2024-01-15T10:35:00Z",
      "messages": [
        {
          "type": "text",
          "content": "I need help with my widget installation"
        }
      ]
    }
  ],
  "session_key": "customer_support_chat"
}