# Arcade Engine API **Canonical:** https://apis.io/apis/arcade/arcade-engine-api/ **Provider:** Arcade — https://apis.io/providers/arcade/ **Base URL:** https://api.arcade.dev **Documentation:** https://docs.arcade.dev/en/references/api Arcade Engine API is one of 4 APIs that [Arcade](https://apis.io/providers/arcade/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 24 JSON Schema definitions. Tagged areas include Engine, Tool Calling, Authorization, and MCP Runtime. The published artifact set on APIs.io includes API documentation, an API reference, an OpenAPI specification, authentication docs, a quickstart, SDKs, and 24 JSON Schemas. The Arcade Engine HTTP API — the control plane for tool catalogs, user authorization flows, tool execution, scheduled tools, MCP gateways, workers, hooks, plugins, and admin operations. Tagged surfaces are Admin, Authorization, Tools, LLM, Operations, Hooks, Gateways, and Plugins. ## Operations (56) | Method | Path | Summary | |---|---|---| | GET | `/v1/admin/auth_providers` | List Auth Providers | | POST | `/v1/admin/auth_providers` | Create an Auth Provider | | GET | `/v1/admin/auth_providers/{id}` | Get an Auth Provider | | DELETE | `/v1/admin/auth_providers/{id}` | Delete an Auth Provider | | PATCH | `/v1/admin/auth_providers/{id}` | Patch an Auth Provider | | GET | `/v1/admin/secrets` | List Secrets | | DELETE | `/v1/admin/secrets/{secret_id}` | Delete Secret | | POST | `/v1/admin/secrets/{secret_key}` | Upsert Secret | | GET | `/v1/admin/settings/session_verification` | Get Session Verification Settings | | PUT | `/v1/admin/settings/session_verification` | Update Session Verification Settings | | GET | `/v1/admin/user_connections` | List Auth Connections | | DELETE | `/v1/admin/user_connections/{id}` | Delete Auth Connection | | POST | `/v1/auth/authorize` | Initiate Authorization | | POST | `/v1/auth/confirm_user` | Confirm User Authorization | | GET | `/v1/auth/status` | Check Authorization Status | | POST | `/v1/auth/validate_custom_verifier` | Test Authorization Flow | | POST | `/v1/chat/completions` | Language Model Chat | | GET | `/v1/config` | Get Engine Config | | GET | `/v1/formatted_tools` | List Formatted Static Tools | | GET | `/v1/formatted_tools/{name}` | Get Formatted Tool Specification | | GET | `/v1/health` | Engine Health Check | | GET | `/v1/hooks` | List Hooks | | POST | `/v1/hooks` | Create a Hook | | PATCH | `/v1/hooks/bulk` | Bulk Upsert Hooks | | GET | `/v1/hooks/{hook_id}` | Get a Hook | | DELETE | `/v1/hooks/{hook_id}` | Delete a Hook | | PATCH | `/v1/hooks/{hook_id}` | Update a Hook | | GET | `/v1/orgs/{org_id}/projects/{project_id}/gateways` | List Gateways | | POST | `/v1/orgs/{org_id}/projects/{project_id}/gateways` | Create a Gateway | | POST | `/v1/orgs/{org_id}/projects/{project_id}/gateways/slug` | Check Gateway Slug Availability | | GET | `/v1/orgs/{org_id}/projects/{project_id}/gateways/{gateway_id}` | Get a Gateway | | PUT | `/v1/orgs/{org_id}/projects/{project_id}/gateways/{gateway_id}` | Update a Gateway | | DELETE | `/v1/orgs/{org_id}/projects/{project_id}/gateways/{gateway_id}` | Delete a Gateway | | PATCH | `/v1/orgs/{org_id}/projects/{project_id}/gateways/{gateway_id}` | Patch a Gateway | | GET | `/v1/plugins` | List Plugins | | POST | `/v1/plugins` | Create a Plugin | | GET | `/v1/plugins/{plugin_id}` | Get a Plugin | | DELETE | `/v1/plugins/{plugin_id}` | Delete a Plugin | | PATCH | `/v1/plugins/{plugin_id}` | Update a Plugin | | GET | `/v1/scheduled_tools` | List Scheduled Tool Executions | | GET | `/v1/scheduled_tools/{id}` | Get Scheduled Tool Execution Details | | GET | `/v1/swagger` | Get Openapi Specification | | GET | `/v1/tools` | List Static Tools | | POST | `/v1/tools/authorize` | Authorize Tool | | POST | `/v1/tools/execute` | Execute Tool | | POST | `/v1/tools/requirements` | Check Tool Requirements | | GET | `/v1/tools/{name}` | Get Arcade Tool Specification | | GET | `/v1/workers` | List All Workers | | POST | `/v1/workers` | Create a Worker | | POST | `/v1/workers/test` | Test a Worker Connection | | GET | `/v1/workers/{id}` | Get a Worker by ID | | DELETE | `/v1/workers/{id}` | Delete a Worker | | PATCH | `/v1/workers/{id}` | Update a Worker | | GET | `/v1/workers/{id}/authorize` | Authorize a Worker | | GET | `/v1/workers/{id}/health` | Get the Health of a Worker | | GET | `/v1/workers/{id}/tools` | List Tools | ## Machine-readable artifacts (40) - **Documentation** — https://docs.arcade.dev - **APIReference** — https://docs.arcade.dev/en/references/api - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/openapi/arcade-engine-openapi.yml - **OpenAPI** — https://api.arcade.dev/v1/swagger - **SpectralRules** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/rules/arcade-engine-rules.yml - **Authentication** — https://docs.arcade.dev/guides/tool-calling/custom-apps/auth-tool-calling - **Quickstart** — https://docs.arcade.dev/en/get-started/quickstarts/call-tool-agent - **Quickstart** — https://docs.arcade.dev/en/get-started/quickstarts/mcp-server-quickstart - **SDK** — https://github.com/ArcadeAI/arcade-py - **SDK** — https://github.com/ArcadeAI/arcade-js - **SDK** — https://github.com/ArcadeAI/arcade-go - **SDK** — https://github.com/ArcadeAI/arcade-java - **SDK** — https://github.com/ArcadeAI/arcade-dotnet - **CLI** — https://docs.arcade.dev/en/references/arcade-cli - **ChangeLog** — https://docs.arcade.dev/en/references/changelog - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-tool-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-tool-execution-detail-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-execute-tool-request-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-execute-tool-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-authorize-tool-request-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-authorization-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-auth-provider-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-worker-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-hook-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-gateway-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-plugin-response-schema.json - **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-schema/arcade-engine-secret-response-schema.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-tool-response-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-tool-execution-detail-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-execute-tool-request-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-execute-tool-response-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-authorize-tool-request-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-authorization-response-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-auth-provider-response-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-worker-response-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-hook-response-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-gateway-response-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-plugin-response-structure.json - **JSONStructure** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/json-structure/arcade-engine-secret-response-structure.json - **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/arcade/refs/heads/main/apis.yml ## Other Arcade APIs (3) - [Arcade Public Schemas](https://apis.io/apis/arcade/arcade-public-schemas/) - [Arcade MCP Framework](https://apis.io/apis/arcade/arcade-mcp-framework/) - [Arcade Integration Catalog](https://apis.io/apis/arcade/arcade-integration-catalog/) ## Tags Engine, Tool Calling, Authorization, MCP Runtime --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/arcade/arcade-engine-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/arcade/.