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

# Test one of a connected integration’s tools

> Runs the tool once against the connected account and returns what the app answered — the same call path an agent takes, so a green test means the agent will get the same result. **It is a real call on real data**: prefer read-only tools, and treat anything that creates, sends or deletes as a production action.



## OpenAPI

````yaml POST /v1/integrations/servers/{id}/tools/{toolName}/test
openapi: 3.0.0
info:
  title: Devic.ai Public API
  description: >-
    Devic.ai is an AI platform that allows you to create, manage, and use AI
    agents for various tasks.
  version: 1.0.0
  contact:
    name: Devic.ai Support
    url: https://devic.ai
  x-logo:
    url: https://devic.ai/logo.png
    altText: Devic.ai Logo
  x-summary: Public API for interacting with Devic.ai platform
servers:
  - url: https://api.devic.ai
    description: Production server
  - url: https://staging-api.devic.ai
    description: Staging server
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Group agents, assistants, documents and costs into projects
  - name: Documents
    description: >-
      Knowledge base documents: create, version, attach and index markdown
      content for RAG
  - name: Document Folders
    description: Organise knowledge base documents into folders and attach them in bulk
  - name: Files
    description: Upload files and obtain shareable download URLs to attach to messages
  - name: Agents
    description: Endpoints related to AI agents and their operations
  - name: Assistants
    description: Endpoints for interacting with assistants and their specializations
  - name: Tool Servers
    description: Endpoints for managing tool servers and their tool definitions
  - name: Health
    description: API health check endpoints
  - name: Documentation
    description: Endpoints for retrieving markdown documentation
  - name: Integrations
    description: Connect third-party apps and turn them into tools
  - name: Triggers
    description: Start an agent or an assistant from an app event
  - name: Tenant Integrations
    description: Apps that each end user connects for themselves
  - name: Memory
    description: What an assistant remembers between conversations
  - name: Skills
    description: Reusable instruction packs for agents and assistants
  - name: Speech to Text
    description: Audio transcription
  - name: Tenants
    description: Tenants, subtenants and their usage
  - name: MCP Gateway
    description: One MCP endpoint over many servers, with visibility per user
  - name: Tenant Sessions
    description: Tokens that prove which end user is calling
paths:
  /v1/integrations/servers/{id}/tools/{toolName}/test:
    post:
      tags:
        - Integrations
      summary: Test one of a connected integration’s tools
      description: >-
        Runs the tool once against the connected account and returns what the
        app answered — the same call path an agent takes, so a green test means
        the agent will get the same result. **It is a real call on real data**:
        prefer read-only tools, and treat anything that creates, sends or
        deletes as a production action.
      operationId: testIntegrationTool
      parameters:
        - name: id
          required: true
          in: path
          description: Integration id
          schema:
            type: string
        - name: toolName
          required: true
          in: path
          description: Tool slug, e.g. `GMAIL_GET_PROFILE`
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestIntegrationToolDto'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestIntegrationToolResponseDto'
        '400':
          description: Not an integration, or the tool is not exposed
        '401':
          description: Unauthorized - Invalid or missing token
        '404':
          description: The app has no such tool
        '429':
          description: Too Many Requests - Rate limit exceeded
        '500':
          description: Internal Server Error
      security:
        - bearerAuth: []
components:
  schemas:
    TestIntegrationToolDto:
      type: object
      properties:
        parameters:
          type: object
          description: >-
            Arguments passed to the tool, as the app expects them. Omit for a
            tool that takes none.
          example:
            max_results: 5
    TestIntegrationToolResponseDto:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the app accepted and ran the call
        data:
          type: object
          description: What the tool returned, exactly as the agent would receive it
        error:
          type: string
          description: Why it failed, in the app’s own words
        requiresUserAction:
          type: boolean
          description: >-
            True when the failure is the connection itself (expired or revoked
            account), not the arguments
        executionTimeMs:
          type: number
          description: Round trip to the app, in milliseconds
        app:
          type: string
          description: App the tool belongs to
          example: gmail
        tool:
          type: string
          description: Tool slug that ran
          example: GMAIL_GET_PROFILE
      required:
        - success
        - executionTimeMs
        - app
        - tool
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use JWT token for authentication

````