К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-getclientconfig.mdиндекс документации — /llms.txt

getClientConfig

Обновлено

GET /api/v1/tools/client-config

Read tenant client configuration

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["client-config:read"]

Параметры запроса

ПолеЗначение
Параметры[]

Тело запроса

ПолеЗначение
Тело запросаnull

Ответы

ПолеЗначение
200.content.application/json.schemaClientConfigView
200.description"Tenant configuration and read-only token balances"
200.headers.X-Bot-Username.description"Authenticated active public bot username when available"
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Authenticated active tenant slug when available"
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Effective per-minute limit"
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.description"Remaining requests, or unknown"
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.description"Window reset epoch seconds"
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
401.content.application/problem+json.schemaProblemDetails
401.description"INVALID_API_KEY: missing, conflicting, invalid, expired or revoked credential; surface JWT unsupported"
403.content.application/problem+json.schemaProblemDetails
403.description"INSUFFICIENT_SCOPE, PUBLISHABLE_KEY_NOT_ALLOWED or NO_ACTIVE_BOT"
404.content.application/problem+json.schemaProblemDetails
404.description"NOT_FOUND: client configuration is unavailable"
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED"
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE: fail-closed resource limit"
429.headers.Retry-After.description"Retry delay in seconds when supplied by resource policy"
429.headers.Retry-After.schema429.headers.Retry-After.schema

Дополнительные условия

ПолеЗначение
description"Owner-authorized singleton selected only by authenticated credential; no path IDs or pagination. Operator locale and spend caps are settings; token balances are read-only. Bearer accepts tgf_* credentials, not surface JWT."
operationId"getClientConfig"
summary"Read tenant client configuration"
tags["client-config"]