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

# Get a run

> Returns a run with its status, result, usage, and transcript events.



## OpenAPI

````yaml /api-reference/openapi.json get /runs/{runId}
openapi: 3.1.0
info:
  description: >-
    Manage a Superlog workspace's automations, runs, tag mode, model access, and
    secrets. Every request acts as the member who created the API key.
  title: Superlog management API
  version: 1.0.0
servers:
  - url: https://superlog.sh/api/v1
security:
  - bearerAuth: []
tags:
  - description: The workspace and its members.
    name: Workspace
  - description: Keys that authenticate the management API and MCP server.
    name: API keys
  - description: Connected integrations and the IDs automations and tag mode use.
    name: Integrations
  - description: Create and change automations.
    name: Automations
  - description: Start, follow, and cancel automation runs.
    name: Runs
  - description: What Superlog can use and change when someone mentions it in Slack.
    name: Tag mode
  - description: Model API keys, subscriptions, and available models.
    name: Models
  - description: Credentials agents can use without seeing them.
    name: Secrets
paths:
  /runs/{runId}:
    get:
      tags:
        - Runs
      summary: Get a run
      description: Returns a run with its status, result, usage, and transcript events.
      operationId: get_automation_run
      parameters:
        - description: Run ID.
          in: path
          name: runId
          required: true
          schema:
            type: string
            format: uuid
            description: Run ID.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  run:
                    type: object
                    properties:
                      automationId:
                        type: string
                        format: uuid
                        description: Automation ID.
                      automationName:
                        type: string
                      cancelRequestedAt:
                        anyOf:
                          - type: string
                            format: date-time
                            description: When cancellation was requested.
                          - type: 'null'
                      completedAt:
                        anyOf:
                          - type: string
                            format: date-time
                            description: When the run finished.
                          - type: 'null'
                      createdAt:
                        type: string
                        format: date-time
                        description: When the run was created.
                      events:
                        type: array
                        items:
                          type: object
                          properties:
                            createdAt:
                              type: string
                              format: date-time
                              description: When the event was recorded.
                            data:
                              anyOf:
                                - type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties: {}
                                - type: 'null'
                            id:
                              type: integer
                            type:
                              type: string
                              description: >-
                                For example `transcript`, `user_message`, or
                                `action_succeeded`.
                          required:
                            - createdAt
                            - data
                            - id
                            - type
                          additionalProperties: false
                        description: The run's transcript and actions, oldest first.
                      failureCategory:
                        anyOf:
                          - type: string
                          - type: 'null'
                      failureMessage:
                        anyOf:
                          - type: string
                          - type: 'null'
                      id:
                        type: string
                        format: uuid
                        description: Run ID.
                      inferenceUsage:
                        anyOf:
                          - type: object
                            properties:
                              costMicros:
                                anyOf:
                                  - type: integer
                                  - type: 'null'
                                description: >-
                                  Model cost in millionths of a US dollar. Null
                                  when a price is unknown.
                              inputTokens:
                                type: integer
                              outputTokens:
                                type: integer
                              requests:
                                type: integer
                            required:
                              - costMicros
                              - inputTokens
                              - outputTokens
                              - requests
                            additionalProperties: false
                          - type: 'null'
                      number:
                        type: integer
                      resultSummary:
                        anyOf:
                          - type: string
                          - type: 'null'
                      startedAt:
                        anyOf:
                          - type: string
                            format: date-time
                            description: When the run started.
                          - type: 'null'
                      status:
                        type: string
                        enum:
                          - pending
                          - running
                          - succeeded
                          - failed
                          - cancelled
                        description: '`pending` and `running` runs are active.'
                      trigger:
                        type: object
                        properties:
                          provider:
                            type: string
                            description: >-
                              What started the run: `manual`, `schedule`,
                              `slack`, `sentry`, or `discord`.
                          sourceUrl:
                            anyOf:
                              - type: string
                              - type: 'null'
                            description: A link to the event that started the run.
                          title:
                            type: string
                          attributes:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              anyOf:
                                - type: string
                                - type: number
                                - type: boolean
                                - type: 'null'
                            description: >-
                              Details of the triggering event, such as a Slack
                              channel or Sentry issue.
                        required:
                          - provider
                          - sourceUrl
                          - title
                          - attributes
                        additionalProperties: false
                    required:
                      - automationId
                      - automationName
                      - cancelRequestedAt
                      - completedAt
                      - createdAt
                      - events
                      - failureCategory
                      - failureMessage
                      - id
                      - inferenceUsage
                      - number
                      - resultSummary
                      - startedAt
                      - status
                      - trigger
                    additionalProperties: false
                required:
                  - run
                additionalProperties: false
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The request is invalid. `issues` lists each invalid field.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The API key is missing, revoked, or its creator left the workspace.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The resource does not exist in this workspace, or automations are
            not enabled.
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          description: A stable machine-readable error code, when there is one.
          type: string
        error:
          type: string
          description: What went wrong.
        issues:
          description: Validation problems, one per invalid field.
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
            required:
              - message
              - path
            additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      description: A workspace API key, created in Superlog under Settings → API keys.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.