Actions
Authorizations
x-api-keystringRequired
Responses
200
Actions retrieved successfully
application/json
keystringRequiredExample:
The key of the action
action-1intentstringRequiredExample:
The intent associated with the action
Summarize latest sales reportoutputSchemaobject · json-schemaOptional
JSON Schema draft 7 schema for action output format
inputSchemaobject · json-schemaOptional
JSON Schema draft 7 schema for action input format
useDefaultMappingbooleanRequiredExample:
Whether default input/output mapping is used
trueupdatedAtstring · date-timeRequiredExample:
Action last update timestamp
2026-04-09T10:15:30.000ZcreatedAtstring · date-timeRequiredExample:
Action creation timestamp
2026-04-01T08:00:00.000Z401
Unauthorized - invalid API key
get
/v1/actionsAuthorizations
x-api-keystringRequired
Body
keystringRequiredExample:
The key of the action to run
action-1userIdstringRequiredExample:
The ID of the user who is running the action
user-123inputobjectOptionalExample:
Input parameters for the action. Required if action has input schema defined.
{"name":"John Doe"}passThroughobject[]OptionalExample:
Pass through data for the action run, e.g. credentials for the integrations used in the run
[{"customerIntegrationId":"integration-1","headers":{"Authorization":"Bearer 1234567890"}}]Responses
200
Action run successfully. Returns runId and output in the shape of action's output schema
application/json
runIdstring · uuidRequired
The ID of the run that was created
outputobjectRequired
The output of the action
401
Unauthorized - invalid API key
post
/v1/actions/runLast updated