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