Skip to main content
GET
/
run
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_inputs": {
    "input_text": "some external text input",
    "input_image": "https://somestatic.png"
  },
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "origin": "manual",
  "status": "not-started",
  "ended_at": "<string>",
  "created_at": "<string>",
  "started_at": "<string>"
}

​
Description

This endpoint retrieves the output of a workflow run by providing the run_id.

​
Parameters

  • run_id (required, query): The ID of the run for which the output is being retrieved.

​
Responses

​
200 OK



`{
  "id": "string",  // Run ID
  "workflow_version_id": "string",  // Workflow version ID
  "workflow_inputs": {  // Inputs provided to the workflow
    "input_text": "string",
    "input_image": "https://somestatic.png"
  },
  "workflow_id": "string",  // ID of the workflow
  "machine_id": "string",  // Machine used to run the workflow
  "origin": "manual | api | public-share",  // Origin of the workflow run
  "status": "not-started | running | uploading | success | failed",  // Current status
  "ended_at": "string",  // End timestamp
  "created_at": "string",  // Creation timestamp
  "started_at": "string"  // Start timestamp
}`

​
400 Workflow Not Found


`{
  "code": "400",
  "message": "Workflow not found"
}`

​
401 Invalid or Expired Token


`Invalid or expired token`

​
500 Error Getting Output


`{
  "error": "string"  // Error message detailing why the output retrieval failed
}`

Authorizations

​
Authorization
string
header
required

API token created in Comfy Deploy /api-keys

Query Parameters

​
run_id
string
required

Response

Retrieve the output

​
id
string<uuid>
required
​
workflow_version_id
string<uuid> | null
required
​
workflow_inputs
object
required
Example:
{
  "input_text": "some external text input",
  "input_image": "https://somestatic.png"
}
​
workflow_id
string<uuid>
required
​
machine_id
string<uuid> | null
required
​
origin
enum<string>
required
Available options:
manual,
api,
public-share
​
status
enum<string>
required
Available options:
not-started,
running,
uploading,
success,
failed
​
ended_at
string | null
required
​
created_at
string
required
​
started_at
string | null
required