Browse documentation

Runs

Retrieve retained run events

Returns public Pi and Salambo events in run sequence order. Requires run:read. Event payloads are read from the encrypted S2 stream.

GET/runs/{runId}/events

Authorization

AuthorizationBearer <token>

Path parameters

runIdstringrequired

pattern: "^run_[A-Za-z0-9]+$"

Query parameters

turn_idstring

pattern: "^turn_[A-Za-z0-9]+$"

limitinteger

minimum: 1
maximum: 1000
default: 100

afterstring

pattern: "^evt_[a-f0-9]{12}x[a-z0-9]+$"

Response

application/json

Retained event page.

object

Additional properties are allowed.

objectstringrequired

const: "list"

dataarrayrequired

Show nested schema

Array items

object

Public Pi or Salambo event. Unknown types and additive fields remain valid.

Additional properties are allowed.

idstringrequired

pattern: "^evt_[a-f0-9]{12}x[a-z0-9]+$"

sequenceintegerrequired

minimum: 1

sourcestringrequired

enum: ["pi","salambo"]

typestringrequired

minLength: 1

run_idstringrequired

pattern: "^run_[A-Za-z0-9]+$"

turn_idstringrequired

pattern: "^turn_[A-Za-z0-9]+$"

created_atintegerrequired

minimum: 0

dataobjectrequired

Additional properties are allowed.

has_morebooleanrequired

next_cursorunionrequired

Show nested schema

Exactly one of

string1

string

pattern: "^evt_[a-f0-9]{12}x[a-z0-9]+$"

null2

null

curl --request GET \
  --url 'https://YOUR_SALAMBO_BASE_URL/api/v1/runs/{runId}/events' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Replace placeholders with your values.

Response

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "sequence": 123,
      "source": "pi",
      "type": "<string>",
      "run_id": "<string>",
      "turn_id": "<string>",
      "created_at": 123,
      "data": {}
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}