Saltar al contenido
Klevy.

Cancelar un run encolado

post /v1/runs/{run_id}/cancel

Cancela un run que todavía está en la cola. Un run que ya empezó a ejecutarse no se cancela: el portal ya recibió la petición.

Autenticación

Requiere API key (sk_live_… · sk_test_…) en la cabecera authorization: Bearer …. Ver autenticación.

Parámetros

NombreEnTipoDescripción
run_idobligatorio path string

Respuesta 200

Run cancelado

run_id string obligatorio
flow string obligatorio
flow_version integer obligatorio
status enum obligatorio
queuedrunningawaiting_confirmationsucceededfailedexpiredcancelled
data object | null obligatorio
document object | null obligatorio
type enum obligatorio
pdfjsonscreenshothtml
download_url string obligatorio
expires_at string obligatorio
sha256 string obligatorio
bytes integer obligatorio
documents object[]

Por omisión: []

type enum obligatorio
pdfjsonscreenshothtml
download_url string obligatorio
expires_at string obligatorio
sha256 string obligatorio
bytes integer obligatorio
source_meta object | null obligatorio
driver string obligatorio
obtained_at string obligatorio
portal string obligatorio
portal_ref string
duration_ms integer
attempts integer
error object | null obligatorio
code enum obligatorio
invalid_paramscredential_invalidcredential_expiredportal_unavailableportal_changednot_foundrate_limitedflow_disabledinternal_errorauthentication_errorpermission_deniedconflict
message string obligatorio
execution_token string
execution_token_expires_at string
session_id string | null
parent_run_id string | null
created_at string obligatorio
finished_at string | null obligatorio