{"uid":"cap_bx9g57tbNgXu84sJv67je","slug":"agents-vimmerse-net-get-workflow-status-2d8ec9f6","name":"Get Workflow Status","description":"Retrieves workflow details including processing status, progress, and generated outputs.\n\nUse this endpoint in polling loops after creation until `processing_status` is `success` or `fail`.","url":"https://agents.vimmerse.net/v2/workflow/{workflow_id}?utm_source=zero.xyz","method":"GET","headers":{},"bodySchema":{"type":"object","required":["workflow_id"],"properties":{"workflow_id":{"type":"string","title":"Workflow ID","examples":["abc123-def456-ghi789"],"description":"Unique identifier of the workflow"}}},"responseSchema":{"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":"Outputs","additionalProperties":true},"payload":{"type":"object","title":"Resolved step payload","additionalProperties":true},"duration":{"type":"integer","title":"Duration","default":0},"used_credits":{"type":"integer","title":"Used Credits","default":0}},"additionalProperties":true},"title":"Completions"},"customer_id":{"type":"string","title":"Customer ID","default":""},"description":{"type":"string","title":"Description","default":""},"delivered_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delivered At"},"error_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Detail"},"media_result":{"type":"array","items":{"type":"object","title":"WorkflowMediaResultItem","properties":{"url":{"type":"string","title":"URL","default":""},"size":{"type":"integer","title":"Size","default":0},"updated_at":{"type":"string","title":"Updated At","default":""}},"additionalProperties":true},"title":"Media Result"},"used_credits":{"type":"integer","title":"Used Credits","default":0},"total_duration":{"type":"integer","title":"Total Duration","default":0},"primary_user_id":{"type":"string","title":"Primary User ID","default":""},"event_submission":{"anyOf":[{"type":"object","additionalProperties":true},{"type":"null"}],"title":"Event Submission"},"processing_status":{"type":"string","title":"Processing Status","default":""},"visibility_status":{"type":"string","title":"Visibility Status","default":""},"progress_percentage":{"type":"integer","title":"Progress Percentage","default":0}},"description":"Workflow API response.","additionalProperties":true},"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_vla5grgpjELzoWEHmF26J","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":"Retrieves the current processing status, progress, and generated outputs for a Vimmerse workflow job by its ID.","exampleAgentPrompt":"Check whether my Vimmerse workflow abc123-def456-ghi789 has finished and give me the output URLs if it's done.","exampleUseCases":[{"title":"Poll video generation until complete","prompt":"Keep checking my Vimmerse workflow job abc123-def456-ghi789 every few seconds and tell me when it finishes — then give me the download links for the generated video."},{"title":"Retrieve outputs from finished image workflow","prompt":"My Vimmerse workflow job def456-ghi789-jkl012 should be done by now — can you fetch the results and show me the image URLs it produced?"},{"title":"Monitor multi-step story workflow for failure","prompt":"Check if workflow ghi789-jkl012-mno345 on Vimmerse succeeded or failed, and if it failed tell me which step went wrong."}],"resultDescription":"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).","failureModes":["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"],"whenToPreferThis":"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).","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-31T00:42:16.938Z","isFirstParty":false,"canonicalSlug":"agents-vimmerse-net-get-workflow-status-2d8ec9f6"}