Skip to main content
POST
apps.action.read

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
action
string
required

Reviewed message read action from the app catalogue.

Pattern: ^[A-Z][A-Z0-9_]{1,127}$
input
object
required

Arguments described by the action catalogue.

since
string

Opaque continuation from a previous read with the same arguments.

Maximum string length: 1024
limit
integer
default:50

Maximum messages in a page.

Required range: 1 <= x <= 100

Response

The result

messages
object[]
required

Messages in the selected channel or chat.

Maximum array length: 100
nextCursor
string

Opaque next page, bound to the caller and action.

Maximum string length: 1024