Create a context connection

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Body

anyOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

and

Responses

201

Created connection

application/json

and

anyOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

post/orgs/{organizationId}/sites/{siteId}/context-connections

POST /v1/orgs/{organizationId}/sites/{siteId}/context-connections HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "connector": "builtin:email",
  "usageSettings": {
    "changeRequests": true,
    "search": true,
    "sync": true,
    "searchBoost": "x0.8"
  },
  "filter": "text"
}

201

Created connection

{
  "object": "context-connection",
  "id": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "syncedAt": "2026-01-01T00:00:00.000Z",
  "label": "text",
  "filter": "text",
  "status": "pending",
  "records": 1,
  "failureMessage": "text",
  "failureReason": "authentication",
  "email": {
    "ingestionAddress": "[e-mail]"
  },
  "usageSettings": {
    "changeRequests": true,
    "search": true,
    "sync": true,
    "searchBoost": "x0.8"
  },
  "urls": {
    "location": "https://example.com"
  },
  "connector": "builtin:email"
}