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

# Cancel a tool call

> Cancels a tool call belonging to a conversation.

conversationRef can be either a conversationId or a persistent userId.




## OpenAPI

````yaml /openapi.yaml post /agents/{agentId}/conversations/{conversationRef}/tool/cancel/{toolCallId}
openapi: 3.0.3
info:
  title: ReyGrid API
  version: 1.0.3
  description: |
    ReyGrid API

    ## Persistent user conversations

    If you want to build a separate conversation system for each user,
    build a wrapper layer around the ReyGrid API.

    The wrapper should manage the application's own user IDs and map them
    to ReyGrid conversations.

    The wrapper is responsible for:
    - Managing and identifying users.
    - Storing the relationship between the application's userId and
      ReyGrid conversationId.
    - Persisting conversation IDs in the application's own database.
    - Reusing the stored conversationId when the same user continues
      a conversation.
    - Verifying that conversation IDs belong to the expected user before
      using them.

    ReyGrid's userId can also be used as a stable identifier for persistent
    conversations. However, if the application requires its own user and
    conversation management, it should maintain this mapping in its own
    database.
servers:
  - url: https://reygrid.com/api/v1
security: []
paths:
  /agents/{agentId}/conversations/{conversationRef}/tool/cancel/{toolCallId}:
    post:
      summary: Cancel a tool call
      description: |
        Cancels a tool call belonging to a conversation.

        conversationRef can be either a conversationId or a persistent userId.
      operationId: cancelToolCall
      parameters:
        - name: agentId
          in: path
          required: true
          description: The ID of the agent.
          schema:
            type: string
        - name: conversationRef
          in: path
          required: true
          description: |
            A conversation ID or persistent user ID.
          schema:
            type: string
        - name: toolCallId
          in: path
          required: true
          description: The ID of the tool call to cancel.
          schema:
            type: string
      responses:
        '200':
          description: Tool call canceled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelToolResponse'
              example:
                success: true
                canceled: true
        '401':
          description: API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
        '404':
          description: Tool call not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: TOOL_CALL_NOT_FOUND
                  message: This tool call does not exist
        '409':
          description: Tool call cannot be canceled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: TOOL_CALL_ALREADY_CANCELED
                  message: This tool call is already canceled
      security:
        - apiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            https://reygrid.com/api/v1/agents/{AgentId}/conversations/user_42/tool/cancel/call_7c57b59c
            \
              -H "Authorization: Bearer $REYGRID_API_KEY"
        - lang: python
          label: Python SDK
          source: |-
            from reygrid import ReyGrid

            client = ReyGrid(api_key="YOUR_API_KEY")

            client.cancel_tool_call("{AgentId}", "user_42", "call_7c57b59c")
        - lang: javascript
          label: TypeScript SDK
          source: >-
            import { ReyGrid } from "reygrid";


            const client = new ReyGrid({ apiKey: "YOUR_API_KEY" });


            await client.cancelToolCall("{AgentId}", "user_42",
            "call_7c57b59c");
components:
  schemas:
    CancelToolResponse:
      type: object
      required:
        - success
        - canceled
      properties:
        success:
          type: boolean
        canceled:
          type: boolean
    AuthErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          example: Unauthorized
        code:
          type: string
          example: AUTH_REQUIRED
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
        output:
          type: object
          additionalProperties: true
        error:
          $ref: '#/components/schemas/Error'
        usage:
          $ref: '#/components/schemas/ChatUsage'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        list:
          type: array
          description: |
            Validation error details.
            Present when error.code is INVALID_BODY.
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
    ChatUsage:
      type: object
      required:
        - credits
      properties:
        credits:
          type: number
    ValidationErrorItem:
      type: object
      additionalProperties: true
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API-Key
      description: ReyGrid API key sent as a Bearer token.

````

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