# Get Workflow Status

> Get Workflow Status is a paid API for AI agents from agents.vimmerse.net, paid per call via MPP, price unknown, status unknown (last checked 2026-10-31).

Retrieves the current processing status, progress, and generated outputs for a Vimmerse workflow job by its ID.

## Facts

- Endpoint: GET https://agents.vimmerse.net/v2/workflow/{workflow_id}?utm_source=zero.xyz
- Price: price unknown
- Payment: MPP
- Status: unknown
- Last checked: 2026-10-31
- Activations on Zero: 0
- Provider: agents.vimmerse.net
- Website: https://agents.vimmerse.net
- Canonical page: https://www.zero.xyz/c/agents-vimmerse-net-get-workflow-status-2d8ec9f6
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_bx9g57tbNgXu84sJv67je

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability agents-vimmerse-net-get-workflow-status-2d8ec9f6
```

Example prompt: Check whether my Vimmerse workflow abc123-def456-ghi789 has finished and give me the output URLs if it's done.

## When to prefer this

Use this endpoint whenever you have started a Vimmerse workflow job (via the Create Workflow endpoint) and need to check whether it has completed and retrieve its output URLs. This is the canonical polling endpoint for Vimmerse workflows — use it in a loop with a delay until processing_status is 'success' or 'fail'. Prefer this over media or story status endpoints when the job was specifically created as a workflow (template-based or multi-scene).

## Known failure modes

- Workflow ID not found — 404 response if the workflow_id does not exist or belongs to another customer
- Workflow still processing — processing_status will be neither 'success' nor 'fail'; agent must continue polling
- Workflow failed — processing_status is 'fail' with no result URLs; agent should surface failure to user
- Authentication/payment error — 401 or 402 if credentials or credits are missing
- Malformed workflow_id — may return 400 or 422 validation error

## How this service works

Retrieves workflow details including processing status, progress, and generated outputs.

Use this endpoint in polling loops after creation until `processing_status` is `success` or `fail`.

## Output

Returns a JSON object with the workflow's current processing_status (e.g. 'success' or 'fail'), generated output URLs with content types, per-step completion details including duration and credits used, input images, timestamps (created_at, updated_at), and associated IDs (media_id, history_id, event_id, customer_id).

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "required": [
  "workflow_id"
 ],
 "properties": {
  "workflow_id": {
   "type": "string",
   "title": "Workflow ID",
   "examples": [
    "abc123-def456-ghi789"
   ],
   "description": "Unique identifier of the workflow"
  }
 }
}
```

## Response schema (JSON Schema)

```json
{
 "type": "object",
 "title": "WorkflowResponse",
 "properties": {
  "id": {
   "type": "string",
   "title": "ID",
   "default": ""
  },
  "model": {
   "type": "string",
   "title": "Template ID",
   "default": ""
  },
  "title": {
   "type": "string",
   "title": "Title",
   "default": ""
  },
  "images": {
   "type": "array",
   "items": {
    "type": "string"
   },
   "title": "Images"
  },
  "rating": {
   "anyOf": [
    {
     "type": "string"
    },
    {
     "type": "null"
    }
   ],
   "title": "Rating"
  },
  "result": {
   "type": "array",
   "items": {
    "type": "object",
    "title": "WorkflowOutputItem",
    "properties": {
     "url": {
      "type": "string",
      "title": "URL",
      "default": ""
     },
     "content_type": {
      "type": "string",
      "title": "Content Type",
      "default": ""
     }
    },
    "additionalProperties": true
   },
   "title": "Result"
  },
  "options": {
   "type": "object",
   "title": "Options",
   "additionalProperties": true
  },
  "event_id": {
   "type": "string",
   "title": "Event ID",
   "default": ""
  },
  "media_id": {
   "anyOf": [
    {
     "type": "string"
    },
    {
     "type": "null"
    }
   ],
   "title": "Media ID"
  },
  "created_at": {
   "type": "string",
   "title": "Created At",
   "default": ""
  },
  "history_id": {
   "anyOf": [
    {
     "type": "string"
    },
    {
     "type": "null"
    }
   ],
   "title": "History ID"
  },
  "posted_url": {
   "anyOf": [
    {
     "type": "string"
    },
    {
     "type": "null"
    }
   ],
   "title": "Posted URL"
  },
  "updated_at": {
   "type": "string",
   "title": "Updated At",
   "default": ""
  },
  "completions": {
   "type": "array",
   "items": {
    "type": "object",
    "title": "WorkflowCompletionResponse",
    "properties": {
     "id": {
      "type": "string",
      "title": "Step ID",
      "default": ""
     },
     "flow": {
      "type": "string",
      "title": "Flow",
      "default": ""
     },
     "result": {
      "type": "array",
      "items": {
       "type": "object",
       "title": "WorkflowOutputItem",
       "properties": {
        "url": {
         "type": "string",
         "title": "URL",
         "default": ""
        },
        "content_type": {
         "type": "string",
         "title": "Content Type",
         "default": ""
        }
       },
       "additionalProperties": true
      },
      "title": "Result"
     },
     "outputs": {
      "type": "object",
      "title": 
… (truncated)
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/agents-vimmerse-net-get-workflow-status-2d8ec9f6/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from agents.vimmerse.net](https://www.zero.xyz/host/agents.vimmerse.net/llms.txt)