Skip to main content
PATCH

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Identificador único del tipo de ítem personalizado (ej. cit_abc123).

processId
string
required

Identificador único del proceso (ej. ccp_def456).

Body

application/json

Debes enviar al menos un campo. process_type y id no se pueden cambiar.

process_reference
string

Renombra la etiqueta. Única dentro del mismo tipo.

is_active
boolean

Activa o pausa el proceso sin eliminarlo. El proceso de clasificación no se puede pausar.

user_input
string

Nuevas instrucciones. Al cambiarlas se crea una nueva versión del proceso, que pasa a ser la activa.

json_schema
object

Solo para procesos de extracción. Define el esquema JSON de salida. Enviarlo crea una nueva versión del proceso. Cuando se envía, auto_improve se establece en false automáticamente; enviar auto_improve: true junto con json_schema devuelve error 400. Enviarlo en un proceso que no es de extracción devuelve 400. Consulta la estructura del json_schema para el formato requerido y ejemplos.

auto_improve
boolean
default:true

Solo aplica cuando user_input cambia. Si es false, las instrucciones mejoradas se rellenan con el user_input tal cual. Cuando se envía json_schema, auto_improve se establece en false automáticamente; enviar true devuelve error 400.

failure_policy
enum<string> | null

Solo para validación. warning: el ítem se pausa hasta que se revise el resultado. hard_stop: si la regla no se cumple, el ítem se da por finalizado. null: el ítem continúa procesándose aunque la regla falle.

Available options:
warning,
hard_stop,
null

Response

Proceso actualizado exitosamente.

success
boolean
Example:

true

data
object