API reference
Use the live OpenAPI and Scalar documents for exact request and response schemas.
Open Connector has two API planes. Pick the plane that matches the caller's identity—agents use a project API key; the console uses a signed-in user session. The native agent API is the default for new integrations.
Live API documents
| Document | URL | Authentication |
|---|---|---|
| Open Connector Scalar UI | api.openconnector.dev/api/v1/ | Project API key for protected operations |
| Open Connector API | api.openconnector.dev/api/v1/spec.json | Public document |
| Console Scalar UI | api.openconnector.dev/api/v1/console | Better Auth session for protected operations |
The server generates these documents from the same runtime API contracts used to handle requests. Use them instead of copying a static endpoint list: they are the authoritative schemas for the deployed version.
Agent plane
Authenticate every native Open Connector API request with a project API key:
curl "https://api.openconnector.dev/api/v1/toolkits?limit=20" \
-H "x-api-key: $OPEN_CONNECTOR_API_KEY"The native API includes connector discovery, auth configs, connections, and tool execution. Use the live Scalar document above for the deployed request and response schemas.
Common agent workflow
- Create an auth config for a connector.
- Create a connected account (or a hosted connect link) for your user.
- Execute a tool against that connection.
curl -X POST "https://api.openconnector.dev/api/v1/tools/GITHUB_ISSUES_CREATE/execute" \
-H "x-api-key: $OPEN_CONNECTOR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"connectedAccountId": "conn_...",
"arguments": {"owner": "acme", "repo": "support", "title": "Issue created through Open Connector"}
}'See Connected Accounts and Calling Tools for the lifecycle and error-handling guidance.
Composio compatibility
Existing Composio SDK integrations can use the compatibility mount at https://api.openconnector.dev/composio/api/v3.1/. For new integrations, use the native /api/v1 API and the Open Connector SDK.
Console plane
The documented Console API is mounted under /api/v1/console. It uses a Better Auth session cookie and is intended for the management console or trusted administrative tooling—not an AI agent.
Project API-key management, organizations, projects, billing, and settings all belong to this session-authenticated plane. For a programmatic workflow, inspect the Console Scalar UI so the route and request shape match the deployed contract.
Authentication boundaries
| Caller | Credential | Scope |
|---|---|---|
| Agent / backend service | x-api-key: oc_... | One project and its connections |
| Console user | Better Auth session cookie | The user's organization permissions |
| OAuth callback | Signed state created by Open Connector | The in-progress connection only |
Never send a project API key to an untrusted browser or use a console session cookie from agent code.
Self-hosted instances
Replace https://api.openconnector.dev with your server's public origin. The routes stay the same:
https://connector.example.com/api/v1/spec.jsonYour OAuth callback base must also be publicly reachable. If you are migrating a Composio client, add /composio/api/v3.1/ to the same public origin; see Environment variables and Deploy to Cloudflare.