GET /workflows/:workflowId

Esta página cubre dos endpoints de lectura de workflows.

Propósito	Endpoint
Definición completa del workflow	`GET /v1/workflows/{workflowId}`
Información ligera para listas	`GET /v1/workflows/{workflowId}/summary`

Crear y editar workflows no está disponible por API. Se hace en el panel.

Leer el detalle del workflow

GET /v1/workflows/{workflowId}

curl "https://client-omni-api.argosidentity.com/v1/workflows/wf_3p8k2m5r9v1t" \
  -H "x-api-key: your-api-key-here"

Campos de la respuesta

Campo	Tipo	Descripción
`id`	`string`	ID del workflow (prefijo `wf_`)
`projectId`	`string`	ID del proyecto padre (prefijo `proj_`)
`name`	`string`	Nombre del workflow
`description`	`string \| null`	Descripción
`status`	`string`	`active` · `archived`
`policyText`	`string \| null`	El texto completo de la política que introdujo. El playbook se genera a partir de este texto
`policyDocuments`	`object[] \| null`	Metadatos de los documentos de política adjuntos. Array vacío si no hay ninguno
`playbookId`	`string \| null`	ID del playbook (prefijo `PB-`). Se mantiene aunque cambie la política y se regenere
`playbookVersion`	`string \| null`	Versión del playbook. Aumenta en cada edición
`playbookContent`	`string \| null`	Cuerpo del playbook (Markdown)
`workflowActions`	`object[]`	Todas las acciones que define el playbook. Vea abajo
`referenceNotes`	`string[]`	Valor derivado y de solo lectura: las `referenceNotes` de todas las acciones, sin duplicados
`engines`	`object[]`	El catálogo de motores del sistema. Vea abajo
`outputSchema`	`object \| null`	JSON Schema (draft-07) que define la estructura del resultado del análisis
`aiModelId`	`string \| null`	ID del modelo de IA seleccionado. `null` si no hay ninguno y se ejecuta el modelo por defecto
`aiModelProvider`	`string \| null`	Identificador del proveedor del modelo seleccionado. `null` significa el modelo por defecto
`aiModel`	`object \| null`	Datos de catálogo del modelo seleccionado. Vea abajo
`profilesCount`	`number`	Número de perfiles vinculados
`totalAnalyses`	`number`	Número acumulado de análisis
`createdAt`	`string`	Fecha de creación
`updatedAt`	`string`	Fecha de última modificación

`workflowActions` definiciones de acciones

Todas las acciones que define el playbook. agentAuditLog.steps en una respuesta de análisis contiene solo las acciones que se ejecutaron realmente, así que use este array como denominador al calcular una tasa de ejecución.

Campo	Tipo	Descripción
`step`	`number`	Orden de ejecución (empieza en 1). Reordenar renumera desde arriba, así que no lo use como identificador
`workId`	`number`	Identificador estable de la acción. Sobrevive a la reordenación y se corresponde con `workId` y `agentAuditLog.steps[].work_id` en la respuesta de análisis
`actionName`	`string`	Nombre de la función de acción (`^[a-z][a-z0-9_]*$`)
`description`	`string`	Descripción de la acción
`referenceNotes`	`string[]`	Notas de referencia de esta acción, con los fundamentos tomados de la política original. Array vacío si no hay ninguna
`engines`	`object[]`	Motores asignados a esta acción. Array vacío si no hay ninguno

Los nombres de las acciones se generan a partir del texto de su política y no son deterministas: regenerar un playbook con la misma política puede producir nombres distintos. Identifique las acciones por workId, nunca por actionName.

`workflowActions.engines`

Campo	Tipo	Descripción
`engineId`	`string`	ID del motor. Se corresponde con `id` en el catálogo `engines`
`type`	`string`	Tipo de motor
`name`	`string`	Nombre visible del motor

`engines` catálogo de motores

La lista completa de motores entre los que puede elegir este workflow. isSelected indica cuáles se usan realmente.

Campo	Tipo	Descripción
`id`	`string`	ID del motor
`code`	`string`	Código del motor
`name`	`string`	Nombre visible del motor
`description`	`string \| null`	Descripción del motor
`executionOrder`	`number`	Orden de aparición en el catálogo
`isSelected`	`boolean`	Si alguna acción de este workflow lo usa realmente
`isRequired`	`boolean`	`true` cuando alguna acción lo marca como obligatorio
`pricePerCall`	`number`	Créditos por llamada

`policyDocuments`

Campo	Tipo	Descripción
`name`	`string`	Nombre del archivo subido
`mimeType`	`string`	Tipo MIME
`size`	`number`	Tamaño del archivo en bytes
`uploadedAt`	`string`	Fecha de subida
`s3Key`	`string`	Clave de referencia del almacenamiento interno. No la use en su lógica de integración

`aiModel`

Campo	Tipo	Descripción
`modelId`	`string`	Identificador del modelo
`displayName`	`string`	Nombre visible del modelo
`provider`	`string`	Identificador del proveedor
`hostingLabel`	`string`	Etiqueta de alojamiento
`description`	`string`	Descripción del modelo
`isDefault`	`boolean`	Si es el modelo por defecto

Los modelos entre los que puede elegir están en selección de modelo de IA.

Ejemplo de respuesta

En la práctica, policyText, playbookContent y outputSchema son mucho más largos, y workflowActions y engines contienen más entradas de las que se muestran aquí.

{
  "id": "wf_3p8k2m5r9v1t",
  "projectId": "proj_75hgxoxamzn9",
  "name": "Vendor Onboarding Document Verification Policy",
  "description": "This is an example for KYB",
  "status": "active",
  "policyText": "Vendor Onboarding Document Verification Policy\n\n1. Required documents\n- A certificate of good standing, a bank verification letter, and a beneficial ownership certification must all be submitted ...",
  "policyDocuments": [],
  "playbookId": "PB-20260910-VM351L",
  "playbookVersion": "1.0.0",
  "playbookContent": "---\nname: playbook.md\ndescription: Vendor onboarding document verification\n---\n...",
  "workflowActions": [
    {
      "step": 1,
      "workId": 1,
      "actionName": "verify_document_presence",
      "description": "Check that all three required documents were submitted",
      "referenceNotes": [
        "All three documents must be submitted (policy 1)",
        "If any one is missing, mark the case for review (policy 1)"
      ],
      "engines": [
        { "engineId": "eng_1a2b3c4d5e6f", "type": "text-similarity", "name": "Text Verifier" }
      ]
    },
    {
      "step": 6,
      "workId": 6,
      "actionName": "record_and_validate_owners",
      "description": "Record beneficial owners and check that ownership percentages do not exceed 100%",
      "referenceNotes": ["If ownership percentages total more than 100%, mark the case for review (policy 6)"],
      "engines": []
    }
  ],
  "referenceNotes": [
    "All three documents must be submitted (policy 1)",
    "If ownership percentages total more than 100%, mark the case for review (policy 6)"
  ],
  "engines": [
    {
      "id": "eng_1a2b3c4d5e6f",
      "code": "text-similarity",
      "name": "Text Verifier",
      "description": "Compares text across documents to check that it matches",
      "executionOrder": 1,
      "isSelected": true,
      "isRequired": false,
      "pricePerCall": 0.02
    },
    {
      "id": "eng_3m4n5o6p7q8r",
      "code": "aml-business",
      "name": "AML - Business",
      "description": "Screens a legal entity name against AML and sanctions lists",
      "executionOrder": 7,
      "isSelected": true,
      "isRequired": false,
      "pricePerCall": 0.15
    }
  ],
  "outputSchema": {
    "type": "object",
    "properties": {
      "company": {
        "type": "object",
        "description": "Company details extracted from the certificate of good standing",
        "properties": {
          "legal_name": { "type": "string", "description": "Registered legal name" },
          "state_file_number": { "type": "string", "description": "State file number" }
        }
      },
      "documents_complete": { "type": "boolean", "description": "Whether all three required documents were submitted" }
    }
  },
  "aiModelId": "<ID del modelo seleccionado>",
  "aiModelProvider": "<identificador del proveedor>",
  "aiModel": {
    "modelId": "<ID del modelo seleccionado>",
    "displayName": "<nombre visible del modelo>",
    "provider": "<identificador del proveedor>",
    "hostingLabel": "<etiqueta de alojamiento>",
    "description": "<descripción del modelo>",
    "isDefault": false
  },
  "profilesCount": 1,
  "totalAnalyses": 1,
  "createdAt": "2026-09-10T05:10:22.000Z",
  "updatedAt": "2026-09-10T05:14:07.000Z"
}

Los valores dentro de aiModel dependen del modelo que elija en el panel, por eso arriba son marcadores de posición. Cuando no selecciona un modelo de IA, aiModelId y aiModelProvider son null y se ejecuta el modelo por defecto.

Leer el resumen del workflow

GET /v1/workflows/{workflowId}/summary

Devuelve solo metadatos, sin los cuerpos de la política, el playbook ni el esquema. Úselo para lecturas ligeras, como pantallas de lista.

curl "https://client-omni-api.argosidentity.com/v1/workflows/wf_3p8k2m5r9v1t/summary" \
  -H "x-api-key: your-api-key-here"

Campo	Tipo	Descripción
`id`	`string`	ID del workflow
`name`	`string`	Nombre del workflow
`description`	`string \| null`	Descripción
`playbookId`	`string \| null`	ID del playbook
`profilesCount`	`number`	Número de perfiles vinculados
`totalAnalyses`	`number`	Número acumulado de análisis
`status`	`string`	Estado del workflow

{
  "id": "wf_3p8k2m5r9v1t",
  "name": "Vendor Onboarding Document Verification Policy",
  "description": "This is an example for KYB",
  "playbookId": "PB-20260910-VM351L",
  "profilesCount": 1,
  "totalAnalyses": 1,
  "status": "active"
}

Códigos de error

Estado	Código	Descripción
404	`OMNI_3003`	Workflow no encontrado

Los errores comunes (400 validación · 401 autenticación · 403 permisos · 500 servidor) están en la descripción general de la API.

Descripción General

Referencia API

GET /workflows/:workflowId

Leer el detalle del workflow

Campos de la respuesta

`workflowActions` definiciones de acciones

`workflowActions.engines`

`engines` catálogo de motores

`policyDocuments`

`aiModel`

Ejemplo de respuesta

Leer el resumen del workflow

Códigos de error

​Leer el detalle del workflow

​Campos de la respuesta

​workflowActions definiciones de acciones

​workflowActions.engines

​engines catálogo de motores

​policyDocuments

​aiModel

​Ejemplo de respuesta

​Leer el resumen del workflow

​Códigos de error

Leer el detalle del workflow

Campos de la respuesta

`workflowActions` definiciones de acciones

`workflowActions.engines`

`engines` catálogo de motores

`policyDocuments`

`aiModel`

Ejemplo de respuesta

Leer el resumen del workflow

Códigos de error