ASAP

ASAP Agents API

Multi-tenant agents platform: agent CRUD plus per-agent knowledge base (Q&A, documents).

GitHub OpenAPI

Operations 10

GET /v1/agents GET /v1/agents #
POST /v1/agents POST /v1/agents #
GET /v1/agents/{id} GET /v1/agents/{id} #
DELETE /v1/agents/{id} DELETE /v1/agents/{id} #
PATCH /v1/agents/{id} PATCH /v1/agents/{id} #
GET /v1/agents/{id}/kb/documents GET /v1/agents/{id}/kb/documents #
POST /v1/agents/{id}/kb/documents POST /v1/agents/{id}/kb/documents #
DELETE /v1/agents/{id}/kb/documents/{doc_id} DELETE `/v1/agents/{id}/kb/documents/{doc_id}` #
GET /v1/agents/{id}/kb/qa GET /v1/agents/{id}/kb/qa #
PUT /v1/agents/{id}/kb/qa PUT /v1/agents/{id}/kb/qa #

Documentation

📖
Documentation
https://docs.asap.cool/reference/
📖
APIReference
https://docs.asap.cool/reference/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/asap-cool/openapi/asap-cool-agents-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-document-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-company-profile-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-update-company-profile-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-contact-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-envelope-view-schema.json
📊
JSONSchema
https://artifacts.apis.io/asap-cool/json-schema/asap-cool-inbound-view-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/asap-cool/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/asap-cool:asap-cool-agents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

asap-cool-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: ASAP Platform Agents API
  description: 'Public HTTP API for ASAP Platform (api.asap.cool).


    All `/v1` responses are wrapped in a standard envelope. Success responses are `{ "data": , "meta": { "request_id", "next_cursor"?, "has_more"? } }` — the schema documented for each operation describes the inner `data` value. Errors are `{ "error": { "code", "message", "field"?, "request_id" } }`. Every response also carries an `X-Request-Id` header matching `meta.request_id` / `error.request_id`.'
  license:
    name: BUSL-1.1
  version: 0.0.0
servers:
- url: https://api.asap.cool
  description: Production
tags:
- name: Agents
  description: 'Multi-tenant agents platform: agent CRUD plus per-agent knowledge base (Q&A, documents).'
paths:
  /v1/agents:
    get:
      tags:
      - Agents
      summary: GET /v1/agents
      operationId: listAgents
      responses:
        '200':
          description: All agents in the active org.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgentView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
    post:
      tags:
      - Agents
      summary: POST /v1/agents
      operationId: createAgent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAgentRequest'
        required: true
      responses:
        '201':
          description: Agent created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
  /v1/agents/{id}:
    get:
      tags:
      - Agents
      summary: GET /v1/agents/{id}
      operationId: getAgent
      parameters:
      - name: id
        in: path
        description: Agent identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Agent found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
    delete:
      tags:
      - Agents
      summary: DELETE /v1/agents/{id}
      operationId: deleteAgent
      parameters:
      - name: id
        in: path
        description: Agent identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Agent deleted.
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
    patch:
      tags:
      - Agents
      summary: PATCH /v1/agents/{id}
      operationId: updateAgent
      parameters:
      - name: id
        in: path
        description: Agent identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAgentRequest'
        required: true
      responses:
        '200':
          description: Agent updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
  /v1/agents/{id}/kb/documents:
    get:
      tags:
      - Agents
      summary: GET /v1/agents/{id}/kb/documents
      operationId: listAgentKbDocuments
      parameters:
      - name: id
        in: path
        description: Agent identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: All documents in this agent's KB.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KbDocumentView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
    post:
      tags:
      - Agents
      summary: POST /v1/agents/{id}/kb/documents
      operationId: createAgentKbDocument
      parameters:
      - name: id
        in: path
        description: Agent identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateKbDocumentRequest'
        required: true
      responses:
        '201':
          description: Document ingested.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KbDocumentView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
  /v1/agents/{id}/kb/documents/{doc_id}:
    delete:
      tags:
      - Agents
      summary: DELETE `/v1/agents/{id}/kb/documents/{doc_id}`
      operationId: deleteAgentKbDocument
      parameters:
      - name: id
        in: path
        description: Agent identifier
        required: true
        schema:
          type: string
          format: uuid
      - name: doc_id
        in: path
        description: Document identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Document deleted.
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Document not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
  /v1/agents/{id}/kb/qa:
    get:
      tags:
      - Agents
      summary: GET /v1/agents/{id}/kb/qa
      operationId: listAgentKbQa
      parameters:
      - name: id
        in: path
        description: Agent identifier
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Curated Q&A pairs for this agent.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KbQaView'
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:read scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
    put:
      tags:
      - Agents
      summary: PUT /v1/agents/{id}/kb/qa
      operationId: replaceAgentKbQa
      parameters:
      - name: id
        in: path
        description: Agent identifier
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceKbQaRequest'
        required: true
      responses:
        '204':
          description: KB Q&A replaced.
        '401':
          description: No active org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Missing agents:write scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Agent not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
components:
  schemas:
    KbQaPairInput:
      type: object
      description: One Q&A pair in a replace request.
      required:
      - question
      - answer
      properties:
        answer:
          type: string
          description: Answer text.
        question:
          type: string
          description: Question text.
    KbDocumentView:
      type: object
      description: Public projection of [`KbDocument`].
      required:
      - id
      - agent_id
      - title
      - byte_size
      - ingested_at
      properties:
        agent_id:
          type: string
          format: uuid
          description: Owning agent.
        byte_size:
          type: integer
          format: int64
          description: Byte size of `content_md`.
        id:
          type: string
          format: uuid
          description: Stable identifier.
        ingested_at:
          type: string
          description: Ingestion timestamp, RFC 3339.
        source_url:
          type:
          - string
          - 'null'
          description: Optional source URL.
        title:
          type: string
          description: Title shown in admin UI.
    KbQaView:
      type: object
      description: One curated Q&A pair, public projection of [`KbQa`].
      required:
      - id
      - agent_id
      - position
      - question
      - answer
      properties:
        agent_id:
          type: string
          format: uuid
          description: Owning agent.
        answer:
          type: string
          description: Curated answer.
        id:
          type: string
          format: uuid
          description: Stable identifier.
        position:
          type: integer
          format: int32
          description: 0-based ordering.
        question:
          type: string
          description: Visitor-facing question.
    UpdateAgentRequest:
      type: object
      description: 'Body for `PATCH /v1/agents/{id}`. Absent fields are unchanged; null

        is only meaningful for the JSON `settings` payload.'
      properties:
        model:
          type:
          - string
          - 'null'
          description: New model id.
        name:
          type:
          - string
          - 'null'
          description: New name.
        persona:
          type:
          - string
          - 'null'
          description: New persona.
        scopes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: New scope list (full replacement).
        settings:
          description: New settings JSONB (full replacement).
        status:
          type:
          - string
          - 'null'
          description: New lifecycle status (`draft` / `live` / `paused`).
        tools:
          type:
          - array
          - 'null'
          items:
            type: string
          description: New tool allowlist (full replacement).
    CreateAgentRequest:
      type: object
      description: Body for `POST /v1/agents`.
      required:
      - kind
      - name
      properties:
        kind:
          type: string
          description: Surface kind (`website_visitor` in V1).
        model:
          type:
          - string
          - 'null'
          description: LLM model id. Defaults to the small Mistral model (`MISTRAL_MODEL_SMALL`, `mistral-small-latest`).
        name:
          type: string
          description: Human-readable name (1–120 chars).
        persona:
          type: string
          description: Persona text (may be empty).
        scopes:
          type: array
          items:
            type: string
          description: Initial scopes. Defaults to `[]`.
        settings:
          description: Kind-specific settings. Defaults to `{}`.
        tools:
          type: array
          items:
            type: string
          description: Initial tool allowlist. Defaults to `[]`.
    ErrorBody:
      type: object
      description: 'Generic error body returned by API handlers when they fail. `code` is a

        stable machine-readable token; `message` is human-friendly and meant for

        surfacing to end users.'
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine token (e.g. `invalid_credentials`).
        field:
          type:
          - string
          - 'null'
          description: Offending request field for validation errors, when known.
        message:
          type: string
          description: Human-readable message.
    AgentView:
      type: object
      description: Public projection of an [`Agent`].
      required:
      - id
      - kind
      - name
      - persona
      - model
      - status
      - scopes
      - tools
      - settings
      - created_at
      - updated_at
      properties:
        created_at:
          type: string
          description: Creation timestamp, RFC 3339.
        id:
          type: string
          format: uuid
          description: Stable identifier.
        kind:
          type: string
          description: Polymorphic surface discriminator.
        model:
          type: string
          description: LLM model id.
        name:
          type: string
          description: Human-readable name.
        persona:
          type: string
          description: Persona injected into the system prompt.
        scopes:
          type: array
          items:
            type: string
          description: OAuth-style scopes the agent's tools may exercise.
        settings:
          description: Free-form kind-specific settings.
        status:
          type: string
          description: Lifecycle status.
        tools:
          type: array
          items:
            type: string
          description: Wire names of tools the agent is allowed to call.
        updated_at:
          type: string
          description: Last update timestamp, RFC 3339.
    CreateKbDocumentRequest:
      type: object
      description: Body for `POST /v1/agents/{id}/kb/documents`.
      required:
      - title
      - content_md
      properties:
        content_md:
          type: string
          description: Document body as Markdown.
        source_url:
          type:
          - string
          - 'null'
          description: Optional source URL.
        title:
          type: string
          description: Title (1–200 chars).
    ReplaceKbQaRequest:
      type: object
      description: Body for `PUT /v1/agents/{id}/kb/qa` — replaces the full list.
      required:
      - pairs
      properties:
        pairs:
          type: array
          items:
            $ref: '#/components/schemas/KbQaPairInput'
          description: Pairs in display order.
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
    session:
      type: apiKey
      in: cookie
      name: asap_session