hosting

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

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

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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>> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`siteId (path)`	`Uuid`	Ano	Site ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`kind`	`string<hosted_files, crawl, manual>`	Ano	—
`url`	`string`	Ne	Required for `crawl` — the address to start from. Same-site links are followed.
`text`	`string`	Ne	Required for `manual`.
`title`	`string`	Ne	A label you will recognise on the screen.

Odpověď

Název	Typ	Požadováno	Co to je
`source`	`ChatAgentSource`	Ano	One place the agent's knowledge comes from, and how that last went.
`pages_read`	`integer`	Ne	—
`truncated`	`string`	Ne	⛔ 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.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422

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