Техническая документация

Инструменты и идентификация.

Поиск инструментов Context4, получение схем действий и проверка идентификационных данных через публичный API.

Сгенерировано из публичного OpenAPI Context4. Авторизация: Authorization: Bearer с API-ключом. Общие правила — API. Полный контракт — OpenAPI JSON. В JSON ниже $ref указывает на именованную схему из раздела «Схемы».

listTools

GET /v1/tools

URL этого стенда: https://context4.me/v1/tools. Параметры в фигурных скобках заменяются фактическими ID из API.

List published tools

Полномочие: tools:read.

Параметры

Имя	Где	Обязателен	Тип и ограничения
`connector_id`	query	нет	{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,78}$","example":"bitrix24"}
`search`	query	нет	{"type":"string","minLength":1,"maxLength":120}
`cursor`	query	нет	{"type":"string","minLength":1,"maxLength":400,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque pagination cursor from a previous response"} Opaque pagination cursor from a previous response
`limit`	query	нет	{"type":"integer","minimum":1,"maximum":100,"description":"Page size (1-100, default 20)"} Page size (1-100, default 20)

Ответы и ошибки

HTTP	Значение	Формат и схема
200	Published tools (flattened connector actions)	`application/json` ToolListResponse
400	Problem (validation_failed)	`application/problem+json` Problem
401	Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked)	`application/problem+json` Problem
403	Problem (capability_missing)	`application/problem+json` Problem
429	Problem (rate_limited)	`application/problem+json` Problem
500	Problem (internal)	`application/problem+json` Problem
503	Problem (service_unavailable)	`application/problem+json` Problem

Заголовки успешного ответа:

Data

{
  "X-Request-Id": {
    "description": "Correlation id echoed on every response",
    "schema": {
      "type": "string"
    }
  },
  "RateLimit-Limit": {
    "description": "Per-key request limit for the current window",
    "schema": {
      "type": "integer"
    }
  },
  "RateLimit-Remaining": {
    "description": "Requests remaining in the current window",
    "schema": {
      "type": "integer"
    }
  },
  "RateLimit-Reset": {
    "description": "Seconds until the current window resets",
    "schema": {
      "type": "integer"
    }
  }
}

getTool

GET /v1/tools/{toolId}

URL этого стенда: https://context4.me/v1/tools/{toolId}. Параметры в фигурных скобках заменяются фактическими ID из API.

Get one tool with its JSON schemas

Полномочие: tools:read.

Параметры

Имя	Где	Обязателен	Тип и ограничения
`toolId`	path	да	{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,78}\.[a-z0-9][a-z0-9_.]{1,78}$","example":"bitrix24.contact.create"}

Ответы и ошибки

HTTP	Значение	Формат и схема
200	Tool detail with pinned input/output schemas	`application/json` ToolDetail
400	Problem (validation_failed)	`application/problem+json` Problem
401	Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked)	`application/problem+json` Problem
403	Problem (capability_missing)	`application/problem+json` Problem
404	Problem (not_found)	`application/problem+json` Problem
429	Problem (rate_limited)	`application/problem+json` Problem
500	Problem (internal)	`application/problem+json` Problem
503	Problem (service_unavailable)	`application/problem+json` Problem

Заголовки успешного ответа:

Data

{
  "X-Request-Id": {
    "description": "Correlation id echoed on every response",
    "schema": {
      "type": "string"
    }
  },
  "RateLimit-Limit": {
    "description": "Per-key request limit for the current window",
    "schema": {
      "type": "integer"
    }
  },
  "RateLimit-Remaining": {
    "description": "Requests remaining in the current window",
    "schema": {
      "type": "integer"
    }
  },
  "RateLimit-Reset": {
    "description": "Seconds until the current window resets",
    "schema": {
      "type": "integer"
    }
  }
}

getIdentity

GET /v1/identity

URL этого стенда: https://context4.me/v1/identity. Параметры в фигурных скобках заменяются фактическими ID из API.

Get the authenticated credential's tenant

Полномочие: connections:read.

Дополнительных параметров в контракте нет.

Ответы и ошибки

HTTP	Значение	Формат и схема
200	Verified organization and workspace; no credential material	`application/json` PublicIdentity
400	Problem (validation_failed)	`application/problem+json` Problem
401	Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked)	`application/problem+json` Problem
403	Problem (capability_missing)	`application/problem+json` Problem
429	Problem (rate_limited)	`application/problem+json` Problem
500	Problem (internal)	`application/problem+json` Problem
503	Problem (service_unavailable)	`application/problem+json` Problem

Заголовки успешного ответа:

Data

{
  "X-Request-Id": {
    "description": "Correlation id echoed on every response",
    "schema": {
      "type": "string"
    }
  },
  "RateLimit-Limit": {
    "description": "Per-key request limit for the current window",
    "schema": {
      "type": "integer"
    }
  },
  "RateLimit-Remaining": {
    "description": "Requests remaining in the current window",
    "schema": {
      "type": "integer"
    }
  },
  "RateLimit-Reset": {
    "description": "Seconds until the current window resets",
    "schema": {
      "type": "integer"
    }
  }
}