> ## 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.

# Start Tool Run

> This endpoint creates a new run of the specified tool with the supplied
inputs. It returns the tool run UID, which can be used to check the status
and retrieve the outputs of the run.

Inputs are specified as a list of dictionaries each containing the title of
the input block and the input.



## OpenAPI

````yaml https:/api.hunch.tools/openapi.json post /v1beta2/tool/start-run
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.hunch.tools
security: []
paths:
  /v1beta2/tool/start-run:
    post:
      tags:
        - Tools
      summary: Start Tool Run
      description: >-
        This endpoint creates a new run of the specified tool with the supplied

        inputs. It returns the tool run UID, which can be used to check the
        status

        and retrieve the outputs of the run.


        Inputs are specified as a list of dictionaries each containing the title
        of

        the input block and the input.
      operationId: start_tool_run
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartToolRunRequest'
              examples:
                - tool_uid: 4p2QJ
                  inputs:
                    - title: Name
                      text: Bob
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartToolRunResponse'
        '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:
    StartToolRunRequest:
      properties:
        tool_uid:
          type: string
          title: Tool Uid
          description: The unique identifier of the tool to run
        inputs:
          items:
            $ref: '#/components/schemas/ToolRunInput'
          type: array
          title: Inputs
          description: The inputs to the tool
      type: object
      required:
        - tool_uid
        - inputs
      title: StartToolRunRequest
      description: The request body used to start a tool run.
    StartToolRunResponse:
      properties:
        tool_run_uid:
          type: string
          title: Tool Run Uid
          description: The unique identifier of the tool run
      type: object
      required:
        - tool_run_uid
      title: StartToolRunResponse
      description: The response body returned after starting 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.
    ToolRunInput:
      properties:
        title:
          type: string
          title: Title
          description: The title of the input block in the tool
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
          description: The value for the input
      type: object
      required:
        - title
        - text
      title: ToolRunInput
      description: Describes an input to a tool.
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````