Connectors

Install a connector

Creates a binding from the preset — base URL, allowed hosts, allowed paths — and starts the OAuth flow for it. Send the user to the returned authorization_url to finish; until they do, the binding exists but holds no credential.

Human users only. Installing gives an agent reach into a third-party account, and the flow it starts is a person's browser.

Idempotent by binding name: re-installing re-runs the OAuth flow against the existing binding rather than creating a second one holding a second token for the same account. A name already taken by a binding that is not this connector returns 409.

post/v1/agents/{agent_id}/connectors/{slug}/install

Request

  • Base URL: https://api.1claw.co
  • URL: https://api.1claw.co/v1/agents/{agent_id}/connectors/{slug}/install
  • Auth: HTTP bearer

Path parameters

agent_idstring uuid required
slugstring required

Connector preset slug, e.g. gmail.

Request body

binding_namestring

Defaults to the preset slug.

scopesstring[]

Narrow the preset's scopes. Widening is refused — the preset's scope list is the reviewed part of a one-click install. Must still include the preset's required scopes.

redirect_afterstring

Where to send the user after the OAuth round trip.

Response

Connector installed; OAuth may still be pending

binding_idstring uuid required
binding_namestring required
preset_slugstring required
authorization_urlstring nullable

Absent for connectors that use a pasted API key rather than OAuth.

next_stepstring required

What the user still has to do, in words.

Changes

No recorded changes to this operation across all 2 revisions of this API.