Aptible Tool API

The Tool API from Aptible — 1 operation(s) for tool.

OpenAPI Specification

aptible-tool-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Tool API
  description: An API for incident response tool servers
  version: 1.0.0
security:
- bearerAuth: []
tags:
- name: Tool
paths:
  /tool/{tool_id}:
    post:
      operationId: callTool
      summary: Query a specific tool
      parameters:
      - name: tool_id
        in: path
        required: true
        schema:
          type: string
        description: The ID of the tool
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolCallPayload'
        x-codegen-request-body-name: body
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolCallResult'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Tool not found
      tags:
      - Tool
components:
  schemas:
    ToolCallResult:
      type: object
      required:
      - result
      properties:
        result:
          type: object
          description: Arbitrary JSON result from the tool.
          required:
          - summary
          properties:
            summary:
              type: string
              description: A summary of the tool call result.
          additionalProperties: true
      additionalProperties: true
    ToolCallPayload:
      type: object
      additionalProperties: true
      description: Arbitrary JSON blob sent to the tool.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Token