# Vimmerse Workflow Estimate Credits

> Vimmerse Workflow Estimate Credits 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).

Returns the estimated credit cost for a POST /v2/workflow call given a template ID and options, without starting a job.

## Facts

- Endpoint: POST https://agents.vimmerse.net/v2/workflow/estimate-credits?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-vimmerse-workflow-estimate-credits-f3895a6a
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_pnnGwkPKo4bKt748_1DbK

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-vimmerse-workflow-estimate-credits-f3895a6a -d '<json body>'
```

Example prompt: Before I kick off the Vimmerse workflow, can you check how many credits the template 'vim_wc26_team' will cost if I run it in video pipeline mode?

## When to prefer this

Use this endpoint when you need to preview or validate the credit cost of a workflow before committing to running it. It requires no authentication and has no side effects, making it safe to call speculatively. Prefer this over checking /v2/workflow directly when cost-awareness or budget validation is required before job creation.

## Known failure modes

- Invalid template_id returns an error or zero credits
- Invalid pipeline_mode value may default or return an error
- If the template defines only one pipeline mode and the wrong one is specified, estimate may not reflect correct price
- Network timeout on the estimate endpoint
- Template not found — unknown template_id returns an error response

## How this service works

Returns the template list-price credits for **POST /v2/workflow** given `template_id` and `options`. No authentication required. When a template defines both image and video list prices, `options.pipeline_mode` (`image` or `video`) selects which applies. Actual runtime charges may include per-step metering and cloud fees beyond this estimate.

## Output

Returns a JSON object with `total_credits` (integer estimate from the template list price) and `breakdown` (object detailing credit components and the selected pipeline mode). No job is created and no credits are charged.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "title": "EstimateWorkflowCreditsRequest",
 "properties": {
  "options": {
   "type": "object",
   "title": "Options",
   "description": "Template options; `pipeline_mode` (`image` vs `video`) selects list price when a template defines both.",
   "additionalProperties": true
  },
  "template_id": {
   "type": "string",
   "title": "Template ID",
   "default": "vim_wc26_team",
   "description": "Workflow template ID (same as POST /v2/workflow)."
  }
 },
 "description": "Body for estimating v2 workflow credits (same fields as create, without starting a job)."
}
```

## Response schema (JSON Schema)

```json
{
 "type": "object",
 "title": "EstimateWorkflowCreditsResponse",
 "required": [
  "total_credits",
  "breakdown"
 ],
 "properties": {
  "breakdown": {
   "type": "object",
   "title": "Breakdown",
   "description": "Template credit components and selected pipeline mode.",
   "additionalProperties": true
  },
  "total_credits": {
   "type": "integer",
   "title": "Total Credits",
   "description": "Estimated credits from the template list price for the given options."
  }
 },
 "description": "Credit estimate aligned with workflow template list prices (anonymous; no user balance)."
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/agents-vimmerse-net-vimmerse-workflow-estimate-credits-f3895a6a/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)
