Documentation

Cancel a prediction

POST
/v1/predictions/{id}/cancel

Authorization

bearerAuth
AuthorizationBearer <token>

Authenticate using an API Key:

Authorization: Bearer rk_live_your-api-key

In: header

Path Parameters

id*string

Prediction ID

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://api.routeany.com/v1/predictions/string/cancel"
{
  "id": "pred_01HXYZ...",
  "model": "google/veo-3.1",
  "capability": "text-to-video",
  "input": {},
  "logs": "string",
  "output": "string",
  "data_removed": true,
  "error": {
    "code": "string",
    "message": "string"
  },
  "source": "api",
  "status": "starting",
  "metrics": {
    "predict_time": 0,
    "total_time": 0
  },
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "urls": {
    "cancel": "http://example.com",
    "get": "http://example.com",
    "web": "http://example.com"
  }
}
{
  "type": "https://api.routeany.com/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid or missing API key",
  "code": "AUTH_INVALID_TOKEN"
}
{
  "type": "https://api.routeany.com/errors/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource was not found",
  "code": "RESOURCE_NOT_FOUND"
}
{
  "type": "https://api.routeany.com/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "The 'prompt' field is required",
  "code": "VALIDATION_INVALID_ARGUMENT",
  "trace_id": "string",
  "request_id": "string",
  "errors": [
    {
      "field": "input.prompt",
      "code": "VALIDATION_INVALID_ARGUMENT",
      "message": "prompt is required"
    }
  ]
}