Skip to main content
Connect an app once per project with OAuth. The agent can then use it in chats you start in the Cloud app.
Runs created with an API key do not get connected-app tools yet. The endpoints below manage the project’s connections; they do not add tools to API runs.

Connect an app

Find the provider name:
Each item has provider, display_name, category, and is_connected. Use popular_only=true or connected_only=true to filter the list, but not both. GET /api/v4/integrations/categories lists the categories. Start OAuth and open the returned redirect_url in a browser:
After you approve access, poll until is_connected is true:

Disconnect an app

Limits

  • Connections belong to the project, not to one API key or session.
  • Zero Data Retention and PHI projects get 403 on authorize. They can still list and disconnect existing connections.
  • Connected apps are not available on the EU deployment.
  • A restricted API key needs integrations Read to list connections and check status, and Write to authorize or disconnect.