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

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

createKnowledge

Обновлено

POST /api/v1/tools/kb

Create tenant knowledge and enqueue indexing

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

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["kb:write"]

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

ПолеЗначение
0.description"Replay the same tenant, credential, route and request for 24 hours."
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema

Тело запроса

ПолеЗначение
content.application/json.schemaKnowledgeCreateRequest
requiredtrue

Ответы

ПолеЗначение
201.content.application/json.schemaKnowledgeEntry
201.description"Created knowledge, queued for indexing; graph statistics may be null."
201.headers.X-Bot-Username.schema201.headers.X-Bot-Username.schema
201.headers.X-Client-Slug.schema201.headers.X-Client-Slug.schema
201.headers.X-RateLimit-Limit.schema201.headers.X-RateLimit-Limit.schema
201.headers.X-RateLimit-Remaining.schema201.headers.X-RateLimit-Remaining.schema
201.headers.X-RateLimit-Reset.schema201.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Strict request validation failed or Idempotency-Key is missing for POST with a body."
400.x-error-codes["VALIDATION_ERROR","IDEMPOTENCY_KEY_REQUIRED"]
401.content.application/problem+json.schemaProblemDetails
401.description"Missing, invalid, revoked or expired API credential. Surface-session JWTs are not accepted."
401.x-error-codes["INVALID_API_KEY"]
403.content.application/problem+json.schemaProblemDetails
403.description"Missing effective scope, forbidden publishable key, inaccessible tenant or no active bot."
403.x-error-codes["INSUFFICIENT_SCOPE","PUBLISHABLE_KEY_NOT_ALLOWED","FORBIDDEN","NO_ACTIVE_BOT"]
409.content.application/problem+json.schemaProblemDetails
409.description"A request with this key is still processing."
409.x-error-codes["CONFLICT"]
413.content.application/problem+json.schemaProblemDetails
413.description"Per-tool payload size or item-count limit exceeded before validation."
413.x-error-codes["PAYLOAD_TOO_LARGE","ITEM_COUNT_EXCEEDED"]
422.content.application/problem+json.schemaProblemDetails
422.description"Idempotency-Key reused with different inputs."
422.x-error-codes["IDEMPOTENCY_KEY_MISMATCH"]
429.content.application/problem+json.schemaProblemDetails
429.description"Per-tool rate limit exceeded or unavailable; fail closed."
429.headers.Retry-After.requiredfalse
429.headers.Retry-After.schema429.headers.Retry-After.schema
429.x-error-codes["RATE_LIMIT_EXCEEDED","RATE_LIMIT_UNAVAILABLE"]
500.content.application/problem+json.schemaProblemDetails
500.description"Unexpected internal failure."
500.x-error-codes["INTERNAL_ERROR"]

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

ПолеЗначение
description"Title is 1–200 characters and content 1–20000. Tags are at most 50 strings of 1–64 characters. Optional prepared_step_seq_nums is an ordered unique list of up to 50 numeric positive-int4 tenant sequences (1–2147483647); [] clears binding. The existing writer queues asynchronous indexing and returns lifecycle state; completion is not implied by HTTP 201. Source type is api_import. Read-only graph counts/status and money commands are not accepted. No pagination or ETag."
operationId"createKnowledge"
summary"Create tenant knowledge and enqueue indexing"
tags["kb"]
x-idempotency.mismatchStatus422
x-idempotency.requiredtrue
x-idempotency.ttlSeconds86400
x-pagination.kind"none"