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

# Get one Play run status

> Returns the canonical status and completed output for one Play run. The additive watchSnapshot=true query returns the bounded no-store snapshot polled by SDK watch.

Authentication: workspace API key in `Authorization: Bearer <key>`.

URL-encode path values, including `/` characters inside Play references and run IDs.

## Errors

| Status | Meaning |
| - | - |
| 401 | The request conflicts with current state or a retained request identity. |
| 404 | The request conflicts with current state or a retained request identity. |
| 500 | The request conflicts with current state or a retained request identity. |


## OpenAPI

````yaml openapi.json GET /api/v2/runs/{runId}
openapi: 3.1.1
info:
  title: Deepline API
  version: v2
  description: >-
    Discover typed GTM tools and callable Plays, then execute a tool or start
    and inspect a durable Deepline Play run. Use the MCP endpoint when your
    client supports Model Context Protocol.
  contact:
    name: Deepline support
    email: team@deepline.com
    url: https://deepline.com/contact
servers:
  - url: https://code.deepline.com
    description: Deepline production runtime API
security: []
tags:
  - name: Health
    description: Availability checks.
  - name: Billing
    description: Safe recovery of existing purchase intent.
  - name: Tools
    description: Discover and execute typed provider tools.
  - name: Plays
    description: Discover, start, and inspect durable Play runs.
externalDocs:
  description: API reference
  url: https://deepline.com/docs/api-reference
paths:
  /api/v2/runs/{runId}:
    get:
      tags:
        - Plays
      summary: Get one Play run status
      description: >-
        Returns the canonical status and completed output for one Play run. The
        additive watchSnapshot=true query returns the bounded no-store snapshot
        polled by SDK watch.
      operationId: getRun
      parameters:
        - name: runId
          in: path
          required: true
          description: The runId returned by the related Deepline API call.
          schema:
            type: string
            minLength: 1
        - name: full
          in: query
          description: >-
            true selects the legacy detail wrapper: status and result are
            top-level, and the compact package is nested under package.
          schema:
            type: boolean
            default: false
        - name: include
          in: query
          description: >-
            Optional comma-separated expansions: nodeStates, runInsights,
            configuration.
          schema:
            type: string
        - name: billing
          in: query
          description: false omits billing enrichment from full or runInsights reads.
          schema:
            type: boolean
            default: true
        - name: watchSnapshot
          in: query
          description: true returns the bounded status snapshot used by SDK watch.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: A successful Runtime API response.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/PlayRunPackage'
                  - type: object
                    properties:
                      status:
                        type: string
                      result: {}
                      package:
                        $ref: '#/components/schemas/PlayRunPackage'
                    required:
                      - status
                      - package
                  - type: object
                    properties:
                      runId:
                        type: string
                      snapshot:
                        type: object
                        description: >-
                          Bounded status snapshot for watchSnapshot=true;
                          includes status, progress, and retained log tail.
                        additionalProperties: true
                      terminalStatus:
                        description: >-
                          Terminal compact package or full detail wrapper, when
                          requested by the SDK watcher.
                    required:
                      - runId
                      - snapshot
              example:
                schemaVersion: 1
                kind: play_run
                run:
                  id: play/prebuilt/person-linkedin-to-email/run/example
                  playName: person-linkedin-to-email
                  status: running
                steps: []
                outputs: {}
                resultState: not_returned
                datasets: []
                next:
                  inspect:
                    kind: deepline_run_inspect
                    runId: play/prebuilt/person-linkedin-to-email/run/example
                    command: >-
                      deepline runs get
                      play/prebuilt/person-linkedin-to-email/run/example
                    api:
                      method: GET
                      path: >-
                        /api/v2/runs/play%2Fprebuilt%2Fperson-linkedin-to-email%2Frun%2Fexample
                  billing:
                    kind: deepline_run_billing
                    runId: play/prebuilt/person-linkedin-to-email/run/example
                    command: >-
                      deepline billing usage --run-id
                      play/prebuilt/person-linkedin-to-email/run/example
                    api:
                      method: GET
                      path: >-
                        /api/v2/runs/play%2Fprebuilt%2Fperson-linkedin-to-email%2Frun%2Fexample?full=true
                  logs:
                    kind: deepline_run_logs
                    runId: play/prebuilt/person-linkedin-to-email/run/example
                    view: tail
                    limit: 100
                    command: >-
                      deepline runs logs
                      play/prebuilt/person-linkedin-to-email/run/example --limit
                      100
                    api:
                      method: GET
                      path: >-
                        /api/v2/runs/play%2Fprebuilt%2Fperson-linkedin-to-email%2Frun%2Fexample/logs?limit=100
        '401':
          description: >-
            The request conflicts with current state or a retained request
            identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Unauthorized
        '404':
          description: >-
            The request conflicts with current state or a retained request
            identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Unauthorized
        '500':
          description: >-
            The request conflicts with current state or a retained request
            identity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Unauthorized
      security:
        - bearerAuth: []
components:
  schemas:
    PlayRunPackage:
      type: object
      required:
        - schemaVersion
        - kind
        - run
        - steps
        - outputs
        - datasets
        - next
      properties:
        schemaVersion:
          type: integer
          const: 1
        kind:
          type: string
          const: play_run
        run:
          type: object
          required:
            - id
            - playName
            - status
          properties:
            id:
              type: string
            playName:
              type: string
            status:
              type: string
              enum:
                - queued
                - running
                - waiting
                - completed
                - failed
                - cancelled
            dashboardUrl:
              type: string
              format: uri
          additionalProperties: true
        steps:
          type: array
          items:
            type: object
            additionalProperties: true
        outputs:
          type: object
          additionalProperties: true
        datasets:
          type: array
          items:
            type: object
            additionalProperties: true
        next:
          type: object
          additionalProperties: true
      additionalProperties: true
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          oneOf:
            - type: string
              description: Route-specific error message.
            - type: object
              properties:
                code:
                  type: string
                message:
                  type: string
                resolution:
                  type: string
              additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Deepline workspace API key
      description: >-
        Create a workspace API key in the Deepline dashboard before calling
        authenticated endpoints.

````

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