FruxonDocs
ApiAgent topics

Get the agent's inbox landscape — the focus structure used to order the topic timeline.

Pass `participantId` to scope to one participant (returns 0 or 1 inbox; empty when the pair has never been routed — this is a read, so it never lazily creates an inbox). Omit it to get the agent's landscape, one inbox per participant, most-recently-active first. The landscape is paginated — an agent can have one inbox per participant it has ever routed to — so use the returned `nextPageToken` to walk further pages; omitting paging returns the first server-default-sized page. Each inbox carries the focal topic id, the focus stack (home-first), the suspended-topic ids, and the home topic id.

GET
/v1/tenants/{tenant}/agents/{agent}/inbox
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

agent*string

The unique identifier of the agent.

tenant*string

The tenant identifier

Query Parameters

PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque cursor token from an external system (e.g. RAG API). When set, M:Fruxon.Common.Collections.PageToken.AsString returns this value directly instead of encoding Fruxon.Common.Collections.PageToken.Skip.

participantId?string

Optional participant filter.

Formatuuid

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/agents/string/inbox"
{
  "inboxes": [
    {
      "participantId": "00000000-0000-0000-0000-000000000000",
      "focalTopicId": "00000000-0000-0000-0000-000000000000",
      "focusStack": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "suspendedTopicIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "homeTopicId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}