---
title: "Install a connector"
method: POST
path: "/v1/agents/{agent_id}/connectors/{slug}/install"
tags: ["Connectors"]
---

# Install a connector

`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

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.

## Path parameters

- `agent_id` string, uuid, required
- `slug` string, required

## Request body

- object
  - `binding_name` string: Defaults to the preset slug.
  - `scopes` string[]: 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_after` string: Where to send the user after the OAuth round trip.

## Response `201`

Connector installed; OAuth may still be pending

- object
  - `binding_id` string, uuid, required
  - `binding_name` string, required
  - `preset_slug` string, required
  - `authorization_url` string, nullable: Absent for connectors that use a pasted API key rather than OAuth.
  - `next_step` string, required: What the user still has to do, in words.

## Other responses

- `400`: Invalid request
- `403`: Insufficient permissions
- `404`: Resource not found
- `409`: Resource already exists or conflict

---

[API](https://skmtc.dev/1claw/apis/1claw-api.md) · [All operations](https://skmtc.dev/1claw/apis/1claw-api/llms.txt) · [OpenAPI document](https://skmtc.dev/1claw/apis/1claw-api/revisions/5fa0918f3b41?raw)