Fail Run

Record a runner-reported failure.

Path Parameters

run_id*string

Formatuuid

Header Parameters

x-workspace-id?|

Workspace UUID for session-authenticated calls.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

lease_id*string

Formatuuid

agent_turns*integer

Range0 <= value

error_code*string

Match^[a-z0-9_]+$

Length1 <= length <= 64

error_message*string

Length1 <= length <= 20000

Response Body

`application/json`

curl -X POST "https://loading/v1/optimization-runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/fail" \  -H "Content-Type: application/json" \  -d '{    "lease_id": "2bb93227-93ec-4b58-a0aa-93b5a1121b74",    "agent_turns": 0,    "error_code": "string",    "error_message": "string"  }'

{
  "status": "preparing",
  "agent_turns": 0,
  "completed_at": "2019-08-24T14:15:22Z"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Fail Run

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`