v1

latestOpenAPI 3.1.02026-08-06209117239.7 KB

sockets

Create integration binding

Create a new integration binding for a socket

post/api/v1/sockets/{socket_id}/integrations

Path parameters

socket_idstring required

Request body

integration_typestring required

Type of integration

integration_namestring required

Name of the integration

auth_configobject required

Authentication configuration

Example request

{
  "permissions": {
    "can_delete": false,
    "can_read": true,
    "can_search": true,
    "can_write": true,
    "filters": {
      "categories": [
        "meeting",
        "project"
      ],
      "exclude_tags": [
        "personal",
        "private"
      ],
      "importance_min": 5
    },
    "rate_limits": {
      "requests_per_day": 10000,
      "requests_per_hour": 500,
      "requests_per_minute": 30
    }
  }
}

Response

Successful Response

integration_typestring required

Type of integration

integration_namestring required

Name of the integration

auth_configobject required

Authentication configuration

binding_idstring required

Unique binding identifier

socket_idstring required

Socket this binding belongs to

is_activeboolean

Whether binding is active

statusstring

Binding status: pending (waiting for first memory), active (has received memory), inactive (manually deactivated)

created_atstring date-time required

Creation timestamp

last_usedstring date-time nullable

Last used timestamp

access_token_previewstring nullable

Preview of access token

Example response

{
  "access_token_preview": "sk_work_socket_abc123...",
  "auth_config": {
    "plugin_id": "gpt-4-work-assistant"
  },
  "binding_id": "binding_550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2023-04-01T14:30:45.123Z",
  "integration_name": "Work Assistant GPT",
  "integration_type": "gpt_plugin",
  "is_active": true,
  "last_used": "2023-04-01T16:45:10.456Z",
  "permissions": {
    "can_delete": false,
    "can_read": true,
    "can_search": true,
    "can_write": true
  },
  "socket_id": "socket_123456789"
}