tools.connectors.connect
Start connecting an app.
Reference
POST/api/v1/connectors/{slug}/connect
- Auth
- API key in
X-API-Key - Content
- none
- Returns
- 200 · ConnectLinkResponse
A link the operator opens to authorize one app for this account. Minted per request and short-lived, so it is fetched when the button is pressed rather than with the page. A link issued alongside a catalogue of 1,500 rows would be expired by the time anybody scrolled to the one they wanted, and 1,500 of them would be absurd. Refuses an app this account has already connected. Two live authorizations for one app leave an operator unable to say which one their agent is using, and the fix afterwards is worse than the refusal now.
Arguments
| Argument | In | Type | Required | Description |
|---|---|---|---|---|
slug | path | string | required | The connector's slug, e.g. gmail. |
Example request
curl -X POST "https://api.decibyl.ai/api/v1/connectors/<slug>/connect" \
-H "X-API-Key: dcb_your_key"Response
{
"app": "string",
"app_name": "string",
"connect_url": "string",
"expires_at": "string"
}Errors
| Status | When |
|---|---|
404 | Not found |
422 | Validation Error |