BEbey-dev
Agent Conversations

Retrieve Conversation

Changed on

Retrieve a single conversation by ID, including its status and participants.

get/v1/conversations/{id}

Request

  • Base URL
    https://api.bey.dev
  • URL
    https://api.bey.dev/v1/conversations/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Conversation ID.

Response

Requested Conversation

idstring required

Unique identifier of the object in the database.

agent_idstring required

ID of agent managing the conversation.

user_namestring nullable

Name of the user.

user_emailstring nullable

Email of the user.

tagsobject

Tags for the conversation.

Example response

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "status": {
    "started_at": "2022-01-01T00:00:00Z"
  }
}

Changes