hosting

POST `/v1/sites/{siteId}/chat-agent/sources`

Tell the agent what to read, and read it now.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/chat-agent/sources \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "kind": <string<hosted_files, crawl, manual>> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

Three kinds of source, and the first is the one no other host can offer. hosted_files reads the site's pages straight off the box we host it on — no crawl, no rate limit, no robots.txt, and no page missed because nothing links to it. It is available only on our own fleet; on a platform we do not run, this returns a source in state failed saying so in as many words rather than quietly falling back. crawl fetches pages over HTTP from an address you give and follows same-site links. It works anywhere, including sites we do not host. manual is text you type — opening hours, a returns policy, an FAQ. Indexing runs immediately and the response says how many pages were read and whether it stopped at a ceiling. truncated is present when it did.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`siteId (path)`	`Uuid`	Так	Site ID (UUIDv7).

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`kind`	`string<hosted_files, crawl, manual>`	Так	—
`url`	`string`	Ні	Required for `crawl` — the address to start from. Same-site links are followed.
`text`	`string`	Ні	Required for `manual`.
`title`	`string`	Ні	A label you will recognise on the screen.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`source`	`ChatAgentSource`	Так	One place the agent's knowledge comes from, and how that last went.
`pages_read`	`integer`	Ні	—
`truncated`	`string`	Ні	⛔ Present only when indexing stopped at a ceiling rather than at the end of the site, and it says how far it got. A truncation nobody reports reads as a complete index.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422

POST /v1/sites/{siteId}/chat-agent/sources