Skip to main content
GET
Get a conversation

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Path Parameters

conversation_id
string
required

The conversation’s id.

Response

The conversation.

object
any
id
string
Example:

"conv_…"

agent_id
string | null

The agent it’s with. null for the conversation of a task run without an agent.

agent_version
integer | null
title
string | null
metadata
object

Your own values, from the first message’s metadata.

variables
object

What it knew from its start: Eager's own (the date and time where the person is, the channel, and more) and the ones passed in with its first message's variables.

session_id
string | null

The conversation’s cloud browser session, once its agent has run a browser task.

created_at
string<date-time>
last_item_at
string<date-time>
status
enum<string>

ended once the agent ended it with its end_conversation tool (sent as the conversation.ended webhook). An ended conversation takes no more messages: a new one is refused with 409 conversation_ended, and a phone call hangs up.

Available options:
open,
ended
ended_at
string<date-time> | null
end_reason
string | null

Why the agent ended it, in its words.

price
object

What it costs at list price, and what for. Left out for the user role.