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

# Get a run



## OpenAPI

````yaml /api/openapi.json get /api/v1/node-runs/{nodeRunId}
openapi: 3.0.2
info:
  title: Melius API
  version: '1'
  description: >-
    The Melius REST API. Authenticate with an API key as a bearer token
    (`Authorization: Bearer mel_...`) and select the team to act on with the
    `x-team-id` header. Generations run through the same node + run pipeline as
    the app: create a node on a canvas, start a run, poll the run, then read the
    resulting version asset.
servers:
  - url: https://api.melius.com
security:
  - apiKey: []
    teamId: []
paths:
  /api/v1/node-runs/{nodeRunId}:
    get:
      tags:
        - run
      summary: Get a run
      operationId: run.get
      parameters:
        - name: nodeRunId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  nodeId:
                    type: string
                    format: uuid
                  nodeVersionId:
                    type: string
                    format: uuid
                    nullable: true
                  toolName:
                    type: string
                    nullable: true
                  status:
                    type: string
                    enum:
                      - pending
                      - running
                      - finished
                      - failed
                      - cancelled
                  errorMessage:
                    type: string
                    nullable: true
                  errorSeverity:
                    default: null
                    type: string
                    enum:
                      - error
                      - warning
                    nullable: true
                  errorRetryable:
                    type: boolean
                    nullable: true
                  numVariationsRequested:
                    type: integer
                    nullable: true
                  numVariationsCompleted:
                    type: integer
                    nullable: true
                  numVariationsFailed:
                    type: integer
                    nullable: true
                  numLayers:
                    type: integer
                    nullable: true
                required:
                  - id
                  - nodeId
                  - nodeVersionId
                  - toolName
                  - status
                  - errorMessage
                  - numVariationsRequested
                  - numLayers
        '401':
          description: Missing, invalid, expired, or revoked API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - statusCode
                  - message
        '403':
          description: The API key's user is not a member of the requested team.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - statusCode
                  - message
        '404':
          description: '404'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '429':
          description: Rate limit reached — retry after the `Retry-After` header.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  retryAfterSeconds:
                    type: integer
                required:
                  - statusCode
                  - message
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'A Melius API key (`mel_...`), sent as `Authorization: Bearer <key>`.'
    teamId:
      type: apiKey
      in: header
      name: x-team-id
      description: The team (workspace) to act on. Defaults to the key's team when omitted.

````