GET /workflows/:workflowId

Endpoint

GET /v1/workflows/{workflowId}

Request

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

Read endpoints return the resource object directly. There is no wrapper field.

Response

string

required

Unique workflow ID (wf_ prefix)

string

required

ID of the project this workflow belongs to (proj_ prefix)

string

required

Workflow name

string | null

Workflow description

string

required

Workflow status (for example active)

string

required

The full natural-language policy text configured on the workflow. The playbook is generated from this text

object | null

Documents attached as policy references. null when none are attached

string

required

ID of the playbook generated from the current policy (PB- prefix)

string

required

Playbook body (frontmatter plus the action workflow definition)

string

required

Playbook version

object[]

required

The complete list of steps defined by the playbook

array

required

Reference notes attached to the workflow

object[]

required

Catalog of engines available to this workflow

object

required

JSON Schema defining the structure of analysis results

number

required

Number of profiles attached to this workflow

number

required

Cumulative number of analyses run with this workflow

string

required

ID of the AI model used for analysis

string

required

AI model provider identifier

object

required

AI model details

string

required

Creation time (ISO 8601)

string

required

Last update time (ISO 8601)

`workflowActions[]` — step definitions

The complete set of steps defined by the playbook. An analysis response’s agentAuditLog.steps contains only the steps that actually ran, so use this array as the denominator when computing execution rate.

Field	Type	Description
`step`	`number`	Step number
`workId`	`number`	Work unit ID. Corresponds to `workId` in the analysis response
`actionName`	`string`	Action function name
`description`	`string`	Action description
`engines`	`array`	Engines configured for this step

`engines[]` — engine catalog

Field	Type	Description
`id`	`string`	Engine ID
`code`	`string`	Engine code (for example `aml-business`)
`name`	`string`	Engine display name
`description`	`string`	Engine description
`executionOrder`	`number`	Execution order
`isSelected`	`boolean`	Whether it is selected on this workflow
`isRequired`	`boolean`	Whether the engine is required
`pricePerCall`	`number`	Price charged per call

`aiModel`

Field	Type	Description
`modelId`	`string`	Model identifier
`displayName`	`string`	Model display name
`provider`	`string`	Provider
`hostingLabel`	`string`	Hosting label
`description`	`string`	Model description
`isDefault`	`boolean`	Whether it is the default model
`maxOutputTokens`	`number`	Maximum output tokens

Example response

The example below is fictional and exists to illustrate the structure. In practice policyText, playbookContent, and outputSchema are much longer and differ per workflow.

{
  "id": "wf_5t9j1r4b7m2q",
  "projectId": "proj_6h4y8s2f0v9n",
  "name": "Corporate Onboarding KYB",
  "description": "Verifies completeness and consistency of documents submitted during corporate onboarding.",
  "status": "active",
  "policyText": "Entity type: Corporate\n\nRequired documents: business registration certificate, corporate registry extract, representative ID...",
  "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": "Check that all required documents were submitted",
      "engines": ["Text Verifier"]
    },
    {
      "step": 2,
      "workId": 2,
      "actionName": "extract_corporate_info",
      "description": "Extract corporate information from the submitted documents",
      "engines": []
    }
  ],
  "referenceNotes": [],
  "engines": [
    {
      "id": "eng_1a2b3c4d5e6f",
      "code": "text-verifier",
      "name": "Text Verifier",
      "description": "Text similarity comparison",
      "executionOrder": 1,
      "isSelected": true,
      "isRequired": false,
      "pricePerCall": 0
    }
  ],
  "outputSchema": {
    "type": "object",
    "properties": {
      "corporate_info": {
        "type": "object",
        "description": "Corporate information extracted from the submitted documents",
        "properties": {
          "company_name": { "type": "string", "description": "Legal entity name" },
          "registration_number": { "type": "string", "description": "Registration number" }
        }
      }
    }
  },
  "profilesCount": 12,
  "totalAnalyses": 34,
  "aiModelId": "example/model-id",
  "aiModelProvider": "argos",
  "aiModel": {
    "modelId": "example/model-id",
    "displayName": "Example Model",
    "provider": "argos",
    "hostingLabel": "Managed",
    "description": "Default model for document analysis",
    "isDefault": true,
    "maxOutputTokens": 8192
  },
  "createdAt": "2026-06-30T08:15:55.195Z",
  "updatedAt": "2026-07-02T04:10:58.004Z"
}