Skip to main content
POST
apps.action.execute

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

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

The action id, as listed by apps.catalog.search, e.g. "GITHUB_CREATE_ISSUE".

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

Arguments for the action, as the action expects them. Default: none.

Response

The result

status
enum<string>
required

Whether the app ran the action.

Available options:
succeeded,
failed
output
any
required

What the app returned: cleaned JSON, with text sanitized and size capped.

error
string

Why the action failed. Only when status is failed.

truncated
boolean

Present when the output was cut to fit the size or depth limit.