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, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

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