GET /workflows/:workflowId

Endpoint

GET /v1/workflows/{workflowId}

Solicitud

curl -X GET "https://client-omni-api.argosidentity.com/v1/workflows/{workflowId}" \
  -H "x-api-key: your-api-key-here"

Los endpoints de consulta devuelven el objeto del recurso directamente. No hay campo envoltorio.

Respuesta

string

requerido

ID único del workflow (prefijo wf_)

string

requerido

ID del proyecto al que pertenece el workflow (prefijo proj_)

string

requerido

Nombre del workflow

string | null

Descripción del workflow

string

requerido

Estado del workflow (por ejemplo active)

string

requerido

Texto completo de la policy en lenguaje natural configurada en el workflow. El playbook se genera a partir de este texto

object | null

Documentos adjuntos como referencia de policy. null si no hay ninguno

string

requerido

ID del playbook generado a partir de la policy actual (prefijo PB-)

string

requerido

Cuerpo del playbook (frontmatter más la definición del flujo de acciones)

string

requerido

Versión del playbook

object[]

requerido

Lista completa de pasos definidos por el playbook

array

requerido

Notas de referencia adjuntas al workflow

object[]

requerido

Catálogo de motores disponibles para este workflow

object

requerido

JSON Schema que define la estructura de los resultados de análisis

number

requerido

Número de perfiles asociados a este workflow

number

requerido

Número acumulado de análisis ejecutados con este workflow

string

requerido

ID del modelo de IA usado en el análisis

string

requerido

Identificador del proveedor del modelo de IA

object

requerido

Detalle del modelo de IA

string

requerido

Momento de creación (ISO 8601)

string

requerido

Momento de la última modificación (ISO 8601)

`workflowActions[]` — definición de pasos

Conjunto completo de pasos definidos por el playbook. El campo agentAuditLog.steps de una respuesta de análisis solo contiene los pasos que realmente se ejecutaron, así que use este array como denominador para calcular la tasa de ejecución.

Campo	Tipo	Descripción
`step`	`number`	Número de paso
`workId`	`number`	ID de unidad de trabajo. Se corresponde con `workId` en la respuesta de análisis
`actionName`	`string`	Nombre de la función de acción
`description`	`string`	Descripción de la acción
`engines`	`array`	Motores configurados para este paso

`engines[]` — catálogo de motores

Campo	Tipo	Descripción
`id`	`string`	ID del motor
`code`	`string`	Código del motor (por ejemplo `aml-business`)
`name`	`string`	Nombre visible del motor
`description`	`string`	Descripción del motor
`executionOrder`	`number`	Orden de ejecución
`isSelected`	`boolean`	Si está seleccionado en este workflow
`isRequired`	`boolean`	Si el motor es obligatorio
`pricePerCall`	`number`	Precio por llamada

`aiModel`

Campo	Tipo	Descripción
`modelId`	`string`	Identificador del modelo
`displayName`	`string`	Nombre visible del modelo
`provider`	`string`	Proveedor
`hostingLabel`	`string`	Etiqueta de hosting
`description`	`string`	Descripción del modelo
`isDefault`	`boolean`	Si es el modelo por defecto
`maxOutputTokens`	`number`	Máximo de tokens de salida

Ejemplo de respuesta

El ejemplo siguiente es ficticio y sirve para ilustrar la estructura. En la práctica policyText, playbookContent y outputSchema son mucho más extensos y varían según el workflow.

{
  "id": "wf_5t9j1r4b7m2q",
  "projectId": "proj_6h4y8s2f0v9n",
  "name": "Corporate Onboarding KYB",
  "description": "Verifica la completitud y consistencia de los documentos enviados durante el onboarding corporativo.",
  "status": "active",
  "policyText": "Entity type: Corporate\n\nDocumentos requeridos: certificado de registro mercantil, extracto del registro, identificación del representante...",
  "policyDocuments": null,
  "playbookId": "PB-20260701-AB12CD",
  "playbookContent": "---\nname: playbook.md\ndescription: Corporate Onboarding KYB\n---\n...",
  "playbookVersion": "1.0.0",
  "workflowActions": [
    {
      "step": 1,
      "workId": 1,
      "actionName": "verify_document_presence",
      "description": "Comprueba que se enviaron todos los documentos requeridos",
      "engines": ["Text Verifier"]
    },
    {
      "step": 2,
      "workId": 2,
      "actionName": "extract_corporate_info",
      "description": "Extrae la información corporativa de los documentos enviados",
      "engines": []
    }
  ],
  "referenceNotes": [],
  "engines": [
    {
      "id": "eng_1a2b3c4d5e6f",
      "code": "text-verifier",
      "name": "Text Verifier",
      "description": "Comparación de similitud de texto",
      "executionOrder": 1,
      "isSelected": true,
      "isRequired": false,
      "pricePerCall": 0
    }
  ],
  "outputSchema": {
    "type": "object",
    "properties": {
      "corporate_info": {
        "type": "object",
        "description": "Información corporativa extraída de los documentos enviados",
        "properties": {
          "company_name": { "type": "string", "description": "Razón social" },
          "registration_number": { "type": "string", "description": "Número de registro" }
        }
      }
    }
  },
  "profilesCount": 12,
  "totalAnalyses": 34,
  "aiModelId": "example/model-id",
  "aiModelProvider": "argos",
  "aiModel": {
    "modelId": "example/model-id",
    "displayName": "Example Model",
    "provider": "argos",
    "hostingLabel": "Managed",
    "description": "Modelo por defecto para análisis documental",
    "isDefault": true,
    "maxOutputTokens": 8192
  },
  "createdAt": "2026-06-30T08:15:55.195Z",
  "updatedAt": "2026-07-02T04:10:58.004Z"
}