Browse docs

Choose an integration path

Choose the path based on who owns the connected account, where calls run, and who operates the credential boundary.

Compare the four paths

PathConnected account belongs toCalls run throughYou operate
Agent setupYouoo CLI or OOMOL MCPThe Agent environment
Hosted Connector SDKYouOOMOL hosted gatewayYour backend code
Connector SaaS projectEach user of your productOOMOL hosted gatewayYour product and user mapping
Self-hosted OpenConnectorYou or your organizationYour OpenConnector runtimeRuntime, storage, security, and updates

Use OOMOL from an Agent

Choose this path when you want Codex, ChatGPT, Claude Code, or another supported Agent to work with Apps you connect.

You will:

  1. Connect an App in OOMOL.
  2. Install oo CLI in the Agent, or configure an MCP client.
  3. Ask the Agent to use the connected App.

Start with the Quickstart.

Call your own connections from backend code

Choose the hosted Connector client when a trusted backend needs to call Apps connected to your OOMOL account.

This path uses a personal API key shaped like api_…. The key stays on the backend and authorizes calls on your own connections.

Read the OOMOL Connector SDK guide.

Let end users connect their accounts

Choose Connector for SaaS when every user of your product needs to authorize their own Gmail, Slack, Notion, or another provider account.

Your backend creates authorization links, stores your user ID beside the resulting connected account ID, and executes actions for that user. This path uses a project API key shaped like oo_proj_….

Read the Connector for SaaS guide.

Run OpenConnector yourself

Choose self-hosting when your team must operate the runtime, database, credential encryption, network access, logs, and upgrade process.

Runtime clients can use a token shaped like oct_…. Provider OAuth apps, encryption keys, storage, backups, and action policy remain your responsibility.

Read the OOMOL OpenConnector self-hosting guide.

Credential scope by product

CredentialUsed byScope
api_…Hosted Connector clientYour personal connections
oo_proj_…ProjectConnector and SaaS APIsOne Connector project and its end users
oct_…OpenConnector client, HTTP, or MCPOne self-hosted runtime

Keep all three credential types in a trusted backend, secret manager, or protected Agent environment. Do not place them in browser bundles, public repositories, or prompts.

Decide with three questions

  1. Whose account is being connected? Your account points to Agent setup or the personal SDK. End-user accounts point to a SaaS project.
  2. Who should operate credential storage and token refresh? Use OOMOL hosting to reduce operations work; self-host when your team must own that boundary.
  3. Where will actions be called? Use Agent setup for interactive Agent work and an SDK or HTTP path for product backend calls.

After choosing a path, follow its Quickstart before adding more providers or production policy.