AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents
TypeScript ai-agentai-agent-toolsai-agentsai-agents-frameworkmcpmcp-servermcp-toolsmcpsn8n-alternativeno-code-automationworkflowworkflow-automationworkflows
icon: 🔌
API & Endpoints
The Activepieces REST API reference. Source: docs/endpoints/ plus generated openapi.json.
Basics
- Auth — API keys, generated in the Platform Dashboard (Platform/Enterprise editions; contact [email protected]). Pass as a Bearer token:
Authorization: Bearer {API_KEY}. - Pagination — seek pagination via
limitandcursorquery params. Responses are{ data, next, previous }wherenext/previousare cursors.
Endpoint groups
Each group has a schema page plus CRUD operations:
- Projects — create, update, list, delete.
- Users — update, list, delete.
- User Invitations — upsert, list, delete.
- Project Members — list, delete.
- Connections — upsert, list, get, delete; Global Connections — upsert, update, list, delete.
- Variables — create, list, update, delete. Reveal and owners are hidden from the reference.
- Flows — create, update, get, list, delete; Flow Runs — get, list.
- Sample Data — get.
- Pieces — schema, install.
- Project Releases — create.
- Git Sync (git-repos) — configure.
- Folders — create, update, get, list, delete.
- Templates — create, delete, get, list.
- Worker Machines — queue metrics.
- Embedding — add allowed embed origins.
- AI Center — provider keys (list, models, suggested models, model options, create, recheck, update, delete), model tiers (list, create, reorder, update, delete), capabilities (list, set up, update, reset), usage (overview, items, item detail), and platform configuration update (default chat model). Platform-admin routes; an API key acts for its platform.
Gotchas
- A published route needs a
responseschema for each real status, or the reference lies. With no response schema Swagger documents200 Default Responsewith no body, so a list loses its fields and areply.status(204)delete is documented as 200. Declare[StatusCodes.OK]: <schema>and[StatusCodes.NO_CONTENT]: z.never(). Two traps:fastify-type-provider-zodtypes the handler's return against the schema's input type, so a field built withz.preprocess(inputunknown, required) rejects real rows at compile time; useoptional().transform(...)instead. And the declared schema is enforced at runtime, so run the route's integration tests after adding one. When patchingdocs/openapi.jsonby hand from a Zod schema, usez.toJSONSchema(schema, { io: 'input' }): a field with.transformhas no JSON Schema output, soio: 'output'documents it as a required{}. docs/openapi.jsonis a committed dump ofGET /api/v1/docs, not generated in CI, and it drifts. Dump it from a cloud edition server: the EE modules (project members, git sync, releases, global connections) only register in the cloud and enterprise editions, so a CE dump deletes them. Merge only the paths you changed instead of replacing the file, or unreviewed internal routes get published.- A route with
tagsandSERVICE_KEY_SECURITY_OPENAPIshows up in the reference as API-key callable. If itssecurityAccessexcludesPrincipalType.SERVICE, sethide: trueinstead.