{"uid":"cap_-nn9GOQBxjxMoF1LofBoV","slug":"agents-vimmerse-net-vimmerse-list-workflow-templates-eadf5815","name":"Vimmerse List Workflow Templates","description":"Returns the workflow template catalog for building UIs, customer scripts, and API playgrounds.\n\nRequires `X-Api-Key`. Templates are scoped to the customer tied to your API key (plus product defaults). Inactive templates are omitted.\n\n**Response shape**\n\n- `detail=false` (default) — summary rows: `template_id`, `inputs`, label, credits, thumbnails, description, category, etc.\n- `detail=true` — full template definition (`available_options`, `steps`, outputs, and related metadata).\n\n**Filters**\n\n- `category` — optional; e.g. `sport`, `marketing`, `general`, `utility`, `healthcare`. Omit to return all categories you can access.\n- `template_ids` — optional; return only specific template IDs (must be in your catalog).\n\n**Examples**\n\n```http\nGET /v2/workflow/templates\nGET /v2/workflow/templates?category=sport\nGET /v2/workflow/templates?detail=true\nGET /v2/workflow/templates?template_ids=vim_wc26_team&detail=true\n```\n\nRe-fetch after deploy when templates or options change.","url":"https://agents.vimmerse.net/v2/workflow/templates?utm_source=zero.xyz","method":"GET","headers":{},"bodySchema":{"type":"object","properties":{"detail":{"type":"boolean","title":"Detail","default":false,"description":"When true, include full template definitions (`available_options`, `steps`, etc.). When false (default), return summary rows only."},"category":{"type":"string","anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"Filter by template category (e.g. sport, marketing, general). Omit to return all categories available to your account."},"template_ids":{"type":"array","anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"items":{"type":"string"},"title":"Template Ids","description":"Return only these template IDs (repeat: `?template_ids=a&template_ids=b`)."}}},"responseSchema":{"type":"object","title":"ListWorkflowTemplatesResponse","properties":{"count":{"type":"integer","title":"Count","default":0},"detail":{"type":"boolean","title":"Detail","default":false,"description":"Whether each item is a full template definition (`true`) or a summary row (`false`)."},"workflow_templates":{"type":"array","items":{"type":"object","additionalProperties":true},"title":"Workflow Templates","description":"Summary or full template objects depending on `detail`."}}},"example":null,"exampleRequest":null,"tags":[],"displayCostAmount":"0.000000","displayCostAsset":"USD","priceDynamic":false,"priceHint":null,"priceStatus":"unknown_unparsed","priceSource":"registry","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"unknown","summary":"price unknown","primary":{"kind":"unknown","protocol":"mpp","network":"tempo","amountUsd":null,"per":"call","confidence":"unknown"},"accepted":[{"kind":"unknown","protocol":"mpp","network":"tempo","amountUsd":null,"per":"call","confidence":"unknown"}]},"paymentMethods":[{"uid":"pm_KDsXr-BlRSl7s6t97-jZp","protocol":"mpp","methodType":"crypto","chain":"tempo","mode":"charge","costAmount":"0.000000","costPer":"request","priority":0,"asset":null,"unit":"request","depositMicros":null,"planRef":null}],"brandName":"agents.vimmerse.net","brandSlug":"agents-vimmerse-net-x402","brandBaseUrl":"https://agents.vimmerse.net","brandDocsUrl":null,"whatItDoes":"Returns the catalog of workflow templates available to your account, with optional full definitions including steps, options, and metadata.","exampleAgentPrompt":"Show me all the workflow templates I have access to in the sport category, including their full definitions with steps and available options.","exampleUseCases":[{"title":"Discover sports workflow templates","prompt":"What sport workflow templates do I have available? Show me a summary of each one including credits and description."},{"title":"Build UI from full template definition","prompt":"I need the full template definition for template ID vim_wc26_team — including all steps, available options, and outputs — so I can build a configuration UI around it."},{"title":"Explore all available template categories","prompt":"List all workflow templates I have access to across every category, just the summary rows with labels, credits, and descriptions."}],"resultDescription":"A JSON object with a count of matching templates, a detail flag, and an array of workflow template objects. In summary mode each object includes template_id, label, description, category, credits, thumbnails, and inputs. In detail mode each object additionally includes available_options, steps, outputs, and related metadata.","failureModes":["Missing or invalid X-Api-Key returns 401/403 unauthorized","Requesting a template_id not in your catalog returns an empty or filtered result","Invalid category string returns an empty result or error","Inactive templates are silently omitted from results","Stale catalog if templates change after deploy and endpoint is not re-fetched"],"whenToPreferThis":"Use this endpoint when you need to discover or enumerate which workflow templates are available before executing a workflow, when building a UI or script that dynamically lists template options, or when you need to inspect full template definitions (steps, inputs, options) for a known template ID. Prefer this over hardcoding template IDs to ensure you only reference templates active in your catalog.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-31T00:42:16.154Z","isFirstParty":false,"canonicalSlug":"agents-vimmerse-net-vimmerse-list-workflow-templates-eadf5815"}