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

# Run tool

> Run an external tool action.



## OpenAPI

````yaml /api-reference/openapi.json post /tools/run
openapi: 3.1.0
info:
  title: Dench API
  version: 1.0.0
  description: >-
    Versioned Dench workspace API. The operation registry is shared with the
    Dench CLI parity layer, so every CLI command maps to an endpoint here.
servers:
  - url: https://www.dench.com/api/v1
security: []
tags:
  - name: agent-config
    description: Agent Config operations.
  - name: approvals
    description: Approvals operations.
  - name: apps
    description: Apps operations.
  - name: auth
    description: Auth operations.
  - name: billing
    description: Billing operations.
  - name: browser
    description: Browser operations.
  - name: chat
    description: Chat operations.
  - name: crm
    description: Crm operations.
  - name: email
    description: Email operations.
  - name: files
    description: Files operations.
  - name: gateway
    description: Gateway operations.
  - name: local
    description: Local operations.
  - name: memory
    description: Memory operations.
  - name: meta
    description: Meta operations.
  - name: routines
    description: Routines operations.
  - name: workspace
    description: Workspace operations.
paths:
  /tools/run:
    post:
      tags:
        - gateway
      summary: Run tool
      description: Run an external tool action.
      operationId: tool_run
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                execution_ref:
                  description: >-
                    Execution ref from a prior search, OR pass
                    session_id+tool_slug.
                  type: string
                session_id:
                  type: string
                tool_slug:
                  description: Composio tool slug, e.g. GMAIL_FETCH_EMAILS.
                  type: string
                arguments:
                  description: Tool arguments object.
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                account:
                  type: string
            example:
              tool_slug: GMAIL_FETCH_EMAILS
              arguments:
                max_results: 10
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    description: Tool output (provider passthrough).
                  error:
                    anyOf:
                      - {}
                      - type: 'null'
                  log_id:
                    type: string
                  execution_mode:
                    type: string
                  tool_slug:
                    type: string
                  tool_router_session_id:
                    type: string
                  toolkit:
                    type: string
                  account:
                    type: string
                additionalProperties: {}
                description: Composio execution result with gateway metadata.
              example:
                data:
                  messages:
                    - id: msg01
                      subject: Quick intro
                error: null
                log_id: log_exec_01
                execution_mode: gateway_tool_router
                tool_slug: GMAIL_FETCH_EMAILS
                tool_router_session_id: trs_abc123
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - DenchApiKey: []
        - AgentSession: []
components:
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Operation or resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
            - code
          properties:
            message:
              type: string
            type:
              type: string
            code:
              type: string
            details: {}
  securitySchemes:
    DenchApiKey:
      type: http
      scheme: bearer
      bearerFormat: DENCH_API_KEY
      description: >-
        Workspace-scoped Dench API key from workspace settings. This is the same
        key used by DENCH_API_KEY in sandboxes.
    AgentSession:
      type: http
      scheme: bearer
      bearerFormat: dch_agent_*
      description: >-
        Agent session token created by `dench signin`. Gateway-backed routes
        exchange this token for the workspace gateway key.

````