Skip to main content
GET
Read the user's link

Authorizations

Authorization
string
header
required

The permit the user approved for your app.

Query Parameters

chat
string | null

A chat to return, starting with chat_.

Example:

"chat_7d3e1a90-4b2c-4e5f-8a6b-1c2d3e4f5a6b"

include
string | null

Send agents to also return the agents the user can start.

Allowed value: "agents"
Example:

"agents"

Response

OK

The user's link to your app: their wallets, running agents and, when asked for, a chat and the agents they can start.

permit_expires_at
string<date-time>
required

When the permit ends. Send the user a new link before then to keep their agents running.

wallets
object[]
required

The wallets the user picked for your app. Empty when they picked none and use paper money only.

sessions
object[]
required

The user's running agents on those wallets and on paper money, newest first.

chat
object | null

The chat you asked for with chat, oldest message first. Null when you asked for none.

agents
object[] | null

With include=agents: the agents the user can start. Circuit's agents, popular community agents and the user's own; the agents most people started in the last 30 days come first, and Circuit's agents come first among equals. Null otherwise.

retry_after_ms
integer<uint64> | null

While Ask is answering in that chat or one of its proposals is being carried out, how many milliseconds to wait before reading again. Null when nothing is in progress.

Required range: x >= 0