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

# Get Tool Run Status

> This endpoint returns the status of the specified tool run. If the run is
completed, it also returns the outputs of the run.

The status of the run can be one of:
- `RUNNING`: The run is still in progress.
- `COMPLETED`: The run has completed successfully.
- `FAILED`: The run has failed.

The outputs are specified as a list of dictionaries each containing the
title of the output block, the output text, and any files.



## OpenAPI

````yaml https:/api.hunch.tools/openapi.json get /v1beta2/tool/run-status/{tool_run_uid}
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.hunch.tools
security: []
paths:
  /v1beta2/tool/run-status/{tool_run_uid}:
    get:
      tags:
        - Tools
      summary: Get Tool Run Status
      description: >-
        This endpoint returns the status of the specified tool run. If the run
        is

        completed, it also returns the outputs of the run.


        The status of the run can be one of:

        - `RUNNING`: The run is still in progress.

        - `COMPLETED`: The run has completed successfully.

        - `FAILED`: The run has failed.


        The outputs are specified as a list of dictionaries each containing the

        title of the output block, the output text, and any files.
      operationId: get_tool_run_status
      parameters:
        - name: tool_run_uid
          in: path
          required: true
          schema:
            type: string
            title: Tool Run Uid
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolRunStatusResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPBadRequestError'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPUnauthorizedError'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPForbiddenError'
          description: Forbidden
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '456':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExposedError'
          description: Additional Response
      security:
        - HTTPBearer: []
components:
  schemas:
    ToolRunStatusResponse:
      properties:
        status:
          $ref: '#/components/schemas/ToolRunStatus'
        outputs:
          anyOf:
            - items:
                $ref: '#/components/schemas/ToolRunOutput'
              type: array
            - type: 'null'
          title: Outputs
          description: The outputs of the tool run, if available
      type: object
      required:
        - status
      title: ToolRunStatusResponse
      description: The response body returned when checking the status of a tool run.
    HTTPBadRequestError:
      properties:
        detail:
          type: string
          title: Detail
      additionalProperties: false
      type: object
      required:
        - detail
      title: HTTPBadRequestError
    HTTPUnauthorizedError:
      properties:
        detail:
          type: string
          title: Detail
      additionalProperties: false
      type: object
      required:
        - detail
      title: HTTPUnauthorizedError
    HTTPForbiddenError:
      properties:
        detail:
          type: string
          title: Detail
      additionalProperties: false
      type: object
      required:
        - detail
      title: HTTPForbiddenError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    HTTPExposedError:
      properties:
        severity:
          $ref: '#/components/schemas/Severity'
          default: error
        title:
          type: string
          title: Title
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
      additionalProperties: false
      type: object
      required:
        - title
      title: HTTPExposedError
      description: >-
        An error that is exposed to the frontend via the API that can be
        rendered as

        a notification.
    ToolRunStatus:
      type: string
      enum:
        - RUNNING
        - COMPLETED
        - FAILED
      title: ToolRunStatus
      description: The status of a tool run.
    ToolRunOutput:
      properties:
        title:
          type: string
          title: Title
          description: The title of the output block in the tool
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
          description: The value of the output
        files:
          items:
            $ref: '#/components/schemas/ToolRunOutputFile'
          type: array
          title: Files
          description: The files contained in the output
      type: object
      required:
        - title
        - text
        - files
      title: ToolRunOutput
      description: Describes an output from a tool run.
    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
    Severity:
      type: string
      enum:
        - error
        - warning
        - info
      title: Severity
    ToolRunOutputFile:
      properties:
        uid:
          type: string
          title: Uid
          description: The unique identifier of the file
        url:
          type: string
          title: Url
          description: The URL to download the file (signed URL with expiry)
      type: object
      required:
        - uid
        - url
      title: ToolRunOutputFile
      description: Describes a file output from a tool run.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````