hosting

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

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

Toute la documentation pour développeurs →

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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ètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`siteId (path)`	`Uuid`	Oui	Site ID (UUIDv7).

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`kind`	`string<hosted_files, crawl, manual>`	Oui	—
`url`	`string`	Non	Required for `crawl` — the address to start from. Same-site links are followed.
`text`	`string`	Non	Required for `manual`.
`title`	`string`	Non	A label you will recognise on the screen.

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`source`	`ChatAgentSource`	Oui	One place the agent's knowledge comes from, and how that last went.
`pages_read`	`integer`	Non	—
`truncated`	`string`	Non	⛔ 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.

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422

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