Activepieces

Activepieces Agent API

The agent API from Activepieces — 5 operation(s) for agent.

GitHub OpenAPI

Operations 9

POST /v1/projects/{projectId}/agent-tools/mcp/validate Create projects by project id agent tools mcp validate #
POST /v1/agents/conversations Create agents conversations #
GET /v1/agents/conversations Get agents conversations #
GET /v1/agents/conversations/{id} Get agents conversations by id #
POST /v1/agents/conversations/{id} Create agents conversations by id #
DELETE /v1/agents/conversations/{id} Delete agents conversations by id #
GET /v1/agents/conversations/{id}/messages Get agents conversations by id messages #
POST /v1/agents/conversations/{id}/messages Create agents conversations by id messages #
POST /v1/agents/tool-approvals/{gateId} Create agents tool approvals by gate id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/activepieces/openapi/activepieces-agent-api-openapi.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/activepieces:activepieces-agent-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

activepieces-agent-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Activepieces Documentation Agent API
  version: 0.0.0
servers:
- url: https://cloud.activepieces.com/api
  description: Production Server
tags:
- name: Agent
paths:
  /v1/projects/{projectId}/agent-tools/mcp/validate:
    post:
      tags:
      - Agent
      description: Probe an external MCP server configured as an agent tool and return its tool names. The outbound call is routed through the SSRF-filtered safeHttp axios; all failure modes collapse to a single generic error so the response cannot be used for port or network reconnaissance.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - MCP
                toolName:
                  type: string
                  minLength: 1
                serverUrl:
                  type: string
                  format: uri
                protocol:
                  type: string
                  enum:
                  - sse
                  - streamable-http
                  - http
                auth:
                  oneOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - none
                    required:
                    - type
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - access_token
                      accessToken:
                        type: string
                    required:
                    - type
                    - accessToken
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - api_key
                      apiKey:
                        type: string
                      apiKeyHeader:
                        type: string
                    required:
                    - type
                    - apiKey
                    - apiKeyHeader
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - headers
                      headers:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties:
                          type: string
                    required:
                    - type
                    - headers
              required:
              - type
              - toolName
              - serverUrl
              - protocol
              - auth
        required: true
      parameters:
      - schema:
          type: string
          pattern: ^[0-9a-zA-Z]{21}$
        in: path
        name: projectId
        required: true
      responses:
        '200':
          description: Default Response
      summary: Create projects by project id agent tools mcp validate
      x-summary-source: derived
      operationId: postV1ProjectsByProjectIdAgentToolsMcpValidate
      x-operation-id-source: derived
  /v1/agents/conversations:
    post:
      tags:
      - Agent
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  anyOf:
                  - type: string
                  - type: 'null'
                modelName:
                  anyOf:
                  - type: string
                  - type: 'null'
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Create agents conversations
      x-summary-source: derived
      operationId: postV1AgentsConversations
      x-operation-id-source: derived
    get:
      tags:
      - Agent
      parameters:
      - schema:
          type: string
        in: query
        name: cursor
        required: false
      - schema:
          default: 20
          type: integer
          minimum: 1
          maximum: 100
        in: query
        name: limit
        required: false
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Get agents conversations
      x-summary-source: derived
      operationId: getV1AgentsConversations
      x-operation-id-source: derived
  /v1/agents/conversations/{id}:
    get:
      tags:
      - Agent
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Get agents conversations by id
      x-summary-source: derived
      operationId: getV1AgentsConversationsById
      x-operation-id-source: derived
    post:
      tags:
      - Agent
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  anyOf:
                  - type: string
                  - type: 'null'
                modelName:
                  anyOf:
                  - type: string
                  - type: 'null'
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Create agents conversations by id
      x-summary-source: derived
      operationId: postV1AgentsConversationsById
      x-operation-id-source: derived
    delete:
      tags:
      - Agent
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Delete agents conversations by id
      x-summary-source: derived
      operationId: deleteV1AgentsConversationsById
      x-operation-id-source: derived
  /v1/agents/conversations/{id}/messages:
    get:
      tags:
      - Agent
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Get agents conversations by id messages
      x-summary-source: derived
      operationId: getV1AgentsConversationsByIdMessages
      x-operation-id-source: derived
    post:
      tags:
      - Agent
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                content:
                  type: string
                  maxLength: 51200
                files:
                  maxItems: 10
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                      mimeType:
                        type: string
                        enum:
                        - image/png
                        - image/jpeg
                        - image/gif
                        - image/webp
                        - text/plain
                        - text/csv
                        - text/markdown
                        - application/json
                        - application/pdf
                      data:
                        type: string
                        maxLength: 13981014
                    required:
                    - name
                    - mimeType
                    - data
              required:
              - content
        required: true
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Create agents conversations by id messages
      x-summary-source: derived
      operationId: postV1AgentsConversationsByIdMessages
      x-operation-id-source: derived
  /v1/agents/tool-approvals/{gateId}:
    post:
      tags:
      - Agent
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                approved:
                  type: boolean
              required:
              - approved
        required: true
      parameters:
      - schema:
          type: string
        in: path
        name: gateId
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Create agents tool approvals by gate id
      x-summary-source: derived
      operationId: postV1AgentsToolApprovalsByGateId
      x-operation-id-source: derived
components:
  securitySchemes:
    apiKey:
      type: http
      description: Use your api key generated from the admin console
      scheme: bearer
externalDocs:
  url: https://www.activepieces.com/docs
  description: Find more info here