> ## Documentation Index
> Fetch the complete documentation index at: https://comfydeploy.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Run



## OpenAPI

````yaml get /run/{run_id}
openapi: 3.1.0
info:
  title: ComfyDeploy API
  description: >+

    ### Overview


    Welcome to the ComfyDeploy API!


    To create a run thru the API, use the [queue run
    endpoint](#tag/run/POST/run/deployment/queue).


    Check out the [get run endpoint](#tag/run/GET/run/{run_id}), for getting the
    status and output of a run.


    ### Authentication


    To authenticate your requests, include your API key in the `Authorization`
    header as a bearer token. Make sure to generate an API key in the [API Keys
    section of your ComfyDeploy account](https://www.comfydeploy.com/api-keys).


    ###

  version: V2
servers:
  - url: https://api.comfydeploy.com/api
    description: Production server
  - url: https://staging.api.comfydeploy.com/api
    description: Staging server
  - url: http://localhost:3011/api
    description: Local development server
security:
  - Bearer: []
paths:
  /run/{run_id}:
    get:
      tags:
        - Run
      summary: Get Run
      operationId: get_run_run__run_id__get
      parameters:
        - name: run_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Run Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRunModel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
        - lang: typescript
          label: SDK (TypeScript)
          source: |-
            import { ComfyDeploy } from "comfydeploy";

            const comfyDeploy = new ComfyDeploy({
              bearer: "<YOUR_BEARER_TOKEN_HERE>",
            });

            async function run() {
              const result = await comfyDeploy.run.get({
                runId: "b888f774-3e7c-4135-a18c-6b985523c4bc",
              });

              // Handle the result
              console.log(result);
            }

            run();
        - lang: python
          label: SDK (Python)
          source: |-
            from comfydeploy import ComfyDeploy

            with ComfyDeploy(
                bearer="<YOUR_BEARER_TOKEN_HERE>",
            ) as comfy_deploy:

                res = comfy_deploy.run.get(run_id="b888f774-3e7c-4135-a18c-6b985523c4bc")

                assert res.workflow_run_model is not None

                # Handle response
                print(res.workflow_run_model)
components:
  schemas:
    WorkflowRunModel:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        workflow_version_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Workflow Version Id
        workflow_inputs:
          anyOf:
            - {}
            - type: 'null'
          title: Workflow Inputs
        workflow_id:
          type: string
          format: uuid
          title: Workflow Id
        workflow_api:
          anyOf:
            - {}
            - type: 'null'
          title: Workflow Api
        machine_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Machine Id
        origin:
          type: string
          title: Origin
        status:
          type: string
          title: Status
        ended_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Ended At
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        queued_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Queued At
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        gpu_event_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Gpu Event Id
        gpu:
          anyOf:
            - type: string
            - type: 'null'
          title: Gpu
        machine_version:
          anyOf:
            - type: string
            - type: 'null'
          title: Machine Version
        machine_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Machine Type
        modal_function_call_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Modal Function Call Id
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
        org_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Org Id
        live_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Live Status
        progress:
          type: number
          title: Progress
          default: 0
        is_realtime:
          type: boolean
          title: Is Realtime
          default: false
        webhook:
          anyOf:
            - type: string
            - type: 'null'
          title: Webhook
        webhook_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Webhook Status
        webhook_intermediate_status:
          type: boolean
          title: Webhook Intermediate Status
          default: false
        outputs:
          items:
            $ref: '#/components/schemas/WorkflowRunOutputModel'
          type: array
          title: Outputs
          default: []
        number:
          type: integer
          title: Number
        duration:
          anyOf:
            - type: number
            - type: 'null'
          title: Duration
        cold_start_duration:
          anyOf:
            - type: number
            - type: 'null'
          title: Cold Start Duration
        cold_start_duration_total:
          anyOf:
            - type: number
            - type: 'null'
          title: Cold Start Duration Total
        run_duration:
          anyOf:
            - type: number
            - type: 'null'
          title: Run Duration
      type: object
      required:
        - id
        - workflow_version_id
        - workflow_inputs
        - workflow_id
        - workflow_api
        - machine_id
        - origin
        - status
        - created_at
        - updated_at
        - gpu_event_id
        - gpu
        - machine_version
        - machine_type
        - modal_function_call_id
        - user_id
        - org_id
        - live_status
        - webhook
        - webhook_status
        - number
        - duration
        - cold_start_duration
        - cold_start_duration_total
        - run_duration
      title: WorkflowRunModel
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkflowRunOutputModel:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        run_id:
          type: string
          format: uuid
          title: Run Id
        data:
          additionalProperties:
            items:
              anyOf:
                - $ref: '#/components/schemas/MediaItem'
                - type: string
            type: array
          type: object
          title: Data
        node_meta:
          anyOf:
            - {}
            - type: 'null'
          title: Node Meta
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
        node_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Node Id
      type: object
      required:
        - id
        - run_id
        - data
        - node_meta
        - created_at
        - updated_at
      title: WorkflowRunOutputModel
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    MediaItem:
      properties:
        url:
          type: string
          title: Url
        type:
          type: string
          title: Type
        filename:
          type: string
          title: Filename
        is_public:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Public
        subfolder:
          anyOf:
            - type: string
            - type: 'null'
          title: Subfolder
        upload_duration:
          anyOf:
            - type: number
            - type: 'null'
          title: Upload Duration
      type: object
      required:
        - url
        - type
        - filename
      title: MediaItem
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````