Technical documentation

Tools and identity.

Discover Context4 tools, retrieve action schemas and inspect identity through the public API.

Generated from the public Context4 OpenAPI. Authenticate with Authorization: Bearer and an API key. General rules: API. Full contract: OpenAPI JSON. In the JSON below, $ref points to a named schema in the Schemas section.

listTools

GET /v1/tools

Deployment URL: https://ctx4.me/v1/tools. Replace parameters in braces with actual IDs from the API.

List published tools

Capability: tools:read.

Parameters

Name	Location	Required	Type and constraints
`connector_id`	query	no	{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,78}$","example":"bitrix24"}
`search`	query	no	{"type":"string","minLength":1,"maxLength":120}
`cursor`	query	no	{"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	no	{"type":"integer","minimum":1,"maximum":100,"description":"Page size (1-100, default 20)"} Page size (1-100, default 20)

Responses and errors

HTTP	Meaning	Format and schema
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

Successful response headers:

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}

Deployment URL: https://ctx4.me/v1/tools/{toolId}. Replace parameters in braces with actual IDs from the API.

Get one tool with its JSON schemas

Capability: tools:read.

Parameters

Name	Location	Required	Type and constraints
`toolId`	path	yes	{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{1,78}\.[a-z0-9][a-z0-9_.]{1,78}$","example":"bitrix24.contact.create"}

Responses and errors

HTTP	Meaning	Format and schema
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

Successful response headers:

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

Deployment URL: https://ctx4.me/v1/identity. Replace parameters in braces with actual IDs from the API.

Get the authenticated credential's tenant

Capability: connections:read.

The contract defines no additional parameters.

Responses and errors

HTTP	Meaning	Format and schema
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

Successful response headers:

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"
    }
  }
}