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

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

getOnboardingState

Обновлено

GET /api/v1/tools/onboarding/state

getOnboardingState

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

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["onboarding:read"]

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

ПолеЗначение
0.in"query"
0.name"intent"
0.requiredfalse
0.schema0.schema

Тело запроса

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

Ответы

ПолеЗначение
200.content.application/json.schema200.content.application/json.schema
200.description"Onboarding state and next action; intent defaults to auto. For a human, entry_context distinguishes the active business, owned candidates and recommended action without switching the active pointer. new_business requests personal creation guidance and is refused for API-key/M2M credentials. No tenant selector is accepted."

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Invalid onboarding entry intent or unknown query field."
401.content.application/problem+json.schemaProblemDetails
401.description"Authentication required."
403.content.application/problem+json.schemaProblemDetails
403.description"Onboarding read scope required."

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

ПолеЗначение
operationId"getOnboardingState"
tags["onboarding"]
x-idempotency"none"