Skip to main content
POST
Start action

Get your Darwin API key here

Create a key in Developer settings.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Start durable work from an exact Search capability and revision.

capabilityId
string
required
Required string length: 1 - 200
capabilityRevision
integer
required
Required range: x >= 1
requestId
string
required
Required string length: 1 - 160
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9._:-]*$
inputs
object
intent
string
Required string length: 1 - 20000
actingAiId
string
Required string length: 1 - 200
targetAiId
string
Required string length: 1 - 200

Response

The current truthful state of the action.

type
enum<string>
required
Available options:
start,
status,
update,
approve,
stop
Allowed value: "start"
actionId
string
required
status
enum<string>
required
Available options:
completed,
running,
awaiting_user,
approval_required,
connection_required,
payment_required,
insufficient_authority,
provider_unavailable,
stopped
result
object
required
actionRequired
string | null
required
availableActions
enum<string>[]
required
Available options:
status,
update,
approve,
stop
interaction
Connection · object