Skip to content
Rigel docs
Open Rigel

See an agent's token request

token_requests

GET/api/v1/token-requests/{request_id}

  • Route

What the agent asked for, for the approval page. Never shows the code or the poll secret. Needs a session.

Parameters#

See an agent's token request: parameters
FieldDescription
request_idpathstringrequired

The request's ID, tkr_….

Response#

200 The request.

See an agent's token request: response fields
FieldDescription
idstringrequired

The request's ID, tkr_….

namestringrequired

What the agent calls itself. The agent wrote this; it isn't checked.

descriptionstringrequired

What the agent says it wants the token for. The agent wrote this too.

requested_accessone of: read_only, read_writerequired

The access the agent asked for.

statusone of: pending, approved, denied, claimed, expiredrequired

pending waits for a person; approved waits for the agent to collect its token; claimed means it has; denied and expired are final.

originstring or nullrequired

Roughly where it was asked from, such as "Brooklyn, US". Null if unknown.

created_atstring (date-time)required

When the agent asked, UTC.

expires_atstring (date-time)required

When it stops being approvable or collectable, UTC.

household_namestring or nullrequired

The household it was approved for, once approved.

accessone of: read_only, read_write, null or nullrequired

The access granted, once approved.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

See an agent's token request: errors
StatusCodeWhen
401unauthenticatedThe request has no valid session.
403Read error.codeDescribed above.
404not_foundThe household doesn't exist, or you aren't a member of it.

Examples#

No call has been recorded for this operation yet, so this example is built from its schema. The values are placeholders.

Built from the schema

Not recorded from a real call: the fields are filled in from the schema, so the values are placeholders.

Request, curl
curl 'https://rigel.house/api/v1/token-requests/req_01K9BKNGK0ENW3AHRZ6DMV29GQ' \
  -H "Cookie: rigel_session=$RIGEL_SESSION"
Request, TypeScript
const response = await fetch("https://rigel.house/api/v1/token-requests/req_01K9BKNGK0ENW3AHRZ6DMV29GQ", {
  headers: {
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
});
const data = await response.json();
Request, HTTP
GET /api/v1/token-requests/req_01K9BKNGK0ENW3AHRZ6DMV29GQ HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Response, 200
HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9BKNGK0ENW3AHRZ6DMV29GQ

{
  "id": "example",
  "name": "Example",
  "description": "example",
  "requested_access": "read_only",
  "status": "pending",
  "origin": "Brooklyn, US",
  "created_at": "2026-11-06T18:00:00Z",
  "expires_at": "2026-11-06T18:00:00Z",
  "household_name": "example",
  "access": "read_only"
}

Rigel is in early access, and sign-up is by invitation. Open Rigel