hosting

PATCH `/v1/sites/{siteId}/chat-agent`

Change the agent's name, personality, brand or the domains it may appear on.

Tabbatar da Asali

Aiko da maɓallin API a matsayin bearer token. Wannan ma'anar ba ta bayyana takamaiman izini ba a cikin ƙayyadaddun bayanai, don haka ba wa maɓallin ku mafi ƙarancin abin da yake buƙata kuma ku bincika amsar maimakon yin zato.

Wannan wurin ƙarewa ba ya buƙatar ID na ƙungiya. Maɓallin ku ya riga ya gano ƙungiyar da yake ciki, kuma an iyakance amsa a kanta.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

curl -X PATCH https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

Everything a visitor sees is here — and it is the customer's brand, not ours. ⛔ allowed_origins is a fence, not a preference. The public endpoints answer only for an origin on this list, and an empty list refuses everything: it means "not installed anywhere yet", never "allow anything". Entries are normalised to scheme://host, so pasting a full page address works. monthly_message_cap is checked before each answer, not reconciled afterwards, so it is a real limit on what this agent can spend rather than a report on what it did.

Sigogi

Suna	Nau'i	Ana buƙata	Abin da yake
`siteId (path)`	`Uuid`	Eh	Site ID (UUIDv7).

Jikin buƙata

Suna	Nau'i	Ana buƙata	Abin da yake
`name`	`string`	A'a	—
`greeting`	`string`	A'a	—
`persona`	`string`	A'a	—
`brand_colour`	`string`	A'a	—
`launcher_position`	`string<left, right>`	A'a	—
`handoff_enabled`	`boolean`	A'a	—
`status`	`string<active, paused>`	A'a	—
`allowed_origins`	`string[]`	A'a	—
`monthly_message_cap`	`integer`	A'a	—

Martani

Suna	Nau'i	Ana buƙata	Abin da yake
`id`	`string`	Eh	—
`site_id`	`string`	A'a	—
`name`	`string`	Eh	What the agent calls itself to visitors. The customer's brand, not ours.
`greeting`	`string`	A'a	—
`persona`	`string`	A'a	Free text describing tone and what to say. ⛔ It cannot widen what the agent may read — retrieval decides that before the model sees anything.
`brand_colour`	`string`	A'a	—
`launcher_position`	`string<left, right>`	A'a	—
`status`	`string<active, paused>`	Eh	`paused` stops it answering and keeps everything it has learned, so switching back on is instant rather than a re-index.
`handoff_enabled`	`boolean`	A'a	Offer to pass the visitor to a person when the agent cannot answer.
`public_key`	`string`	Eh	Carried in the embed snippet. It identifies the agent and authorises nothing a page's reader could not already do — the fence is `allowed_origins`.
`allowed_origins`	`string[]`	Eh	Origins the public endpoints will answer for. ⛔ Empty refuses everything — it means "not installed yet", never "allow anything".
`monthly_message_cap`	`integer`	A'a	Messages included per calendar month. Checked before each answer.
`messages_this_month`	`integer`	A'a	—
`indexed_chunks`	`integer`	A'a	Passages of the site currently searchable. Zero means it knows nothing yet.
`embed_snippet`	`string`	A'a	The two lines to paste into any website.
`sources`	`ChatAgentSource[]`	Eh	—

Kuskuren da wannan matsaya za ta iya maido wa

401 · 403 · 404 · 422

PATCH /v1/sites/{siteId}/chat-agent