Run an action of an application

POST

/v1/apps/{app}/actions/{action}

curl --request POST \
  --url https://api.eu.apigami.com/v1/apps/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/actions/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

• Production, EU (Frankfurt)

Runs the action named by its operationId, with the request body as its input, and relays what the code answered: its status, headers and bytes, plus X-Apigami-Run-Id and X-Apigami-Served-By (revision or sandbox). An answer without X-Apigami-Run-Id is Apigami refusing. X-Apigami-Version names a version to try, for an API key of an application of the owning team; a version never deployed runs in a sandbox. Past thirty seconds the answer is 202 { run_id, state: "running" }. An API key or a run token: a member’s token, agent token included, runs an action through the MCP tool app_run instead.

Authorizations

• apiKey

Parameters

Path Parameters

app

required

string format: uuid

action

required

string

<= 120 characters

Header Parameters

X-Apigami-Version

string format: uuid

The version to run instead of production’s.

X-Apigami-User-Ref

string

With an API key: the person the run serves.

X-Apigami-Install-Ref

string

With an API key: one of that person’s browsers.

Request Body

Media typeapplication/json

The input the action’s own schema defines.

object

Example^generated

{}

Responses

200

What the action answered, relayed. Its status may be any other.

202

Still running after thirty seconds.

Media typeapplication/json

object

run_id

required

string format: uuid

state

required

string

Allowed values: running

expires_at

required

string format: date-time

waiting_behind_run_id

A trial of the same version still running ahead of this one: the trials of one version share one sandbox, so it may hold this one until it ends.

string format: uuid

nullable

Example

{
  "state": "running"
}

401

No API key or run token.

Media typeapplication/json

object

error

required

string

consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean

Example

{
  "error": "bad client credentials"
}

403

A version named by a caller outside the owning team, or the person named by X-Apigami-User-Ref not reached: not connected, their account disabled by Apigami, or out of the team of your private app.

Media typeapplication/json

object

error

required

string

consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean

Examples

{
  "error": "only a member of the owning group may name a version of an application"
}

{
  "error": "not paired"
}

{
  "error": "account disabled"
}

{
  "error": "app is private"
}