hosting
POST /v1/sites/{siteId}/chat-agent/sources
Tell the agent what to read, and read it now.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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>> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
siteId (path) | Uuid | Igen | Site ID (UUIDv7). |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
kind | string<hosted_files, crawl, manual> | Igen | — |
url | string | Nem | Required for crawl — the address to start from. Same-site links are followed. |
text | string | Nem | Required for manual. |
title | string | Nem | A label you will recognise on the screen. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
source | ChatAgentSource | Igen | One place the agent's knowledge comes from, and how that last went. |
pages_read | integer | Nem | — |
truncated | string | Nem | ⛔ 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. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422