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

# Get a Run

<Note>
  `uid` is used for all the endpoints and Run manipulation.

  The `id` is an internal identifier returned to smooth and improve speed and accuracy if you have questions about your runs you will want
  to submit to the team.
</Note>


## OpenAPI

````yaml v1/api/actions.json get /runs/{run_uid}
openapi: 3.1.0
info:
  title: ED Automation External API
  description: This is the External API documentation for ED Automation
  version: dev
servers:
  - url: https://api.edges.run/v1
security:
  - XApiKeyAuth: []
paths:
  /runs/{run_uid}:
    get:
      tags:
        - public / runs
      summary: Get run by UUID
      operationId: getRun
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: run_uid
          required: true
          description: Run UUID
      responses:
        '200':
          description: Returns the run
          content:
            application/json:
              schema:
                description: Returns the run
                type: object
                properties:
                  id:
                    type: integer
                    description: Run ID
                  uid:
                    type: string
                    format: uuid
                    description: Run UUID
                  name:
                    type: string
                    nullable: true
                    maxLength: 255
                    description: User-defined label for the run
                  scheduled_run_name:
                    type: string
                    nullable: true
                    maxLength: 255
                    description: Name of the linked scheduled run, if any
                  action_id:
                    type: integer
                    description: Action ID
                  action_name:
                    type: string
                    description: Action name
                  retry_count:
                    type: integer
                    description: Retry count
                    default: 0
                  user_uid:
                    type: string
                    format: uuid
                    description: Member/User UUID
                  workspace_uid:
                    type: string
                    format: uuid
                    description: Workspace UUID
                  execution_mode:
                    type: string
                    enum:
                      - LIVE
                      - ASYNC
                    description: Execution mode
                    nullable: true
                  last_error:
                    type: object
                    description: Last error message
                    properties:
                      label:
                        type: string
                        description: Label
                      message:
                        type: string
                        description: Message
                      params:
                        type: object
                        additionalProperties:
                          type: string
                        nullable: true
                    nullable: true
                  parameters:
                    type: object
                    properties:
                      sync_mode:
                        type: string
                        enum:
                          - full
                          - incremental
                        default: full
                        title: Synchronization Mode
                        description: >-
                          Controls how data is fetched. `full` retrieves all
                          available data (limited by `max_results`).
                          `incremental` retrieves only new data since the last
                          processed item. Incremental runs can be continued
                          using `/v1/runs/{run_uid}/continue`.
                    additionalProperties: true
                  callback:
                    type: object
                    description: Callback (only for async runs)
                    properties:
                      url:
                        type: string
                        description: Callback URL
                    nullable: true
                  status:
                    type: string
                    description: Run status
                    enum:
                      - CREATED
                      - INVALID
                      - QUEUED
                      - SCHEDULED
                      - BLOCKED
                      - STOPPED
                      - RUNNING
                      - FAILED
                      - PARTIAL_SUCCEEDED
                      - SUCCEEDED
                    nullable: true
                  output_count:
                    type: integer
                    description: Number of outputs generated by the run
                    default: 0
                    nullable: true
                  scheduled_run_uid:
                    type: string
                    format: uuid
                    description: >-
                      If the run is scheduled, this field indicates the
                      scheduled run UUID.
                    nullable: true
                  started_at:
                    type: string
                    description: Started at
                    nullable: true
                  finished_at:
                    type: string
                    description: Finished at
                    nullable: true
                  created_at:
                    type: string
                    description: Created at
                  updated_at:
                    type: string
                    description: Updated at
                    nullable: true
                additionalProperties: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-0'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-0'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/def-0'
components:
  schemas:
    def-0:
      title: APIError
      description: >-
        Represents an error returned by the API. This schema defines the
        standard structure of error messages to ensure consistent error handling
        across the application.
      type: object
      properties:
        error_label:
          type: string
          nullable: true
        error_scope:
          type: string
          enum:
            - input
            - integ
            - param
            - config
          nullable: true
        error_ref:
          type: string
          nullable: true
          example: ERR-12345
        message:
          type: string
        status_code:
          type: integer
          nullable: true
        params:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
              - type: array
                items:
                  type: string
          nullable: true
        data:
          type: object
          nullable: true
          additionalProperties: true
          description: Additional data about the error
      additionalProperties: false
  securitySchemes:
    XApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````