Skip to main content
PATCH
/
agents
/
{agentId}
/
runs
/
{runId}
cURL
curl --request PATCH \
  --url https://api.cradl.ai/{basePath}/agents/{agentId}/runs/{runId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "status": "archived"
}
'
{
  "agentId": "<string>",
  "runId": "<string>",
  "updatedTime": "<string>",
  "updatedBy": "<string>",
  "createdBy": "<string>",
  "createdTime": "<string>",
  "id": "<string>",
  "variablesFileUrl": "<string>",
  "events": [
    {}
  ],
  "resourceIds": [
    "<string>"
  ],
  "status": "archived"
}

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

​
agentId
string
required
​
runId
string
required

Body

application/json
​
status
enum<string>
Available options:
archived

Response

200 response

​
agentId
string
required
Pattern: ^cradl:agent:[a-f0-9]{32}$
​
runId
string
required
Pattern: ^cradl:run:[a-f0-9]{32}$
​
updatedTime
string | null
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})$
​
updatedBy
string | null
Maximum string length: 4096
​
createdBy
string | null
Maximum string length: 4096
​
createdTime
string | null
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})$
​
id
string
Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:agent:[a-z0-9-_]+/cradl:run:[a-z0-9-_]+$
​
variablesFileUrl
string | null
Pattern: ^http://localhost.*|^https://.*
​
events
object[]
​
resourceIds
string[]
​
status
enum<string>
Available options:
archived,
exported,
pending-export,
pending-predictions,
ready-for-review,
review-completed,
succeeded-predictions,
error,
running,
completed,
review-in-progress