Skip to main content
PATCH
/
actions
/
{actionId}
/
runs
/
{runId}
cURL
curl --request PATCH \
  --url https://api.cradl.ai/{basePath}/actions/{actionId}/runs/{runId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "output": {},
  "metadata": {},
  "status": "failed"
}
'
{
  "updatedTime": "<string>",
  "metadata": {},
  "updatedBy": "<string>",
  "description": "<string>",
  "createdBy": "<string>",
  "name": "<string>",
  "actionId": "<string>",
  "createdTime": "<string>",
  "runId": "<string>",
  "warnings": [
    "<string>"
  ],
  "history": [
    {}
  ],
  "agentRunId": "<string>",
  "output": {},
  "input": {},
  "noAgentRunUpdate": true,
  "logId": "<string>",
  "id": "<string>",
  "errors": [
    "<string>"
  ],
  "status": "failed"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Content-Type
string
required

Path Parameters

​
runId
string
required
​
actionId
string
required

Body

application/json
​
output
object
​
metadata
object
​
status
enum<string>
Available options:
failed,
succeeded

Response

200 response

​
updatedTime
string | null
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
metadata
object
required
​
updatedBy
string | null
required
Maximum string length: 4096
​
description
string | null
required
Maximum string length: 4096
​
createdBy
string
required
Maximum string length: 4096
​
name
string | null
required
Maximum string length: 4096
​
actionId
string
required
Pattern: ^cradl:action:[a-f0-9]{32}$
​
createdTime
string
required
Pattern: ^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$
​
runId
string
required
Pattern: ^cradl:run:[a-f0-9]{32}$
​
warnings
string[] | null
​
history
object[]
​
agentRunId
string | null
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:agent:[a-z0-9-_]+/cradl:run:[a-z0-9-_]+$
​
output
object
​
input
object
​
noAgentRunUpdate
boolean
​
logId
string | null
Pattern: ^(cradl|las):log:[a-f0-9]{32}$
​
id
string
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:action:[a-z0-9-_]+/cradl:run:[a-z0-9-_]+$
​
errors
string[] | null
​
status
enum<string>
Available options:
failed,
ignored,
running,
succeeded