hosting

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

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

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د API په کنسول کې پرانیزئ

تفصیلات

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.

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`siteId (path)`	`Uuid`	هو	Site ID (UUIDv7).

د غوښتنې بدن

نوم	ډول	اړین	دا څه شی دی
`name`	`string`	نه	—
`greeting`	`string`	نه	—
`persona`	`string`	نه	—
`brand_colour`	`string`	نه	—
`launcher_position`	`string<left, right>`	نه	—
`handoff_enabled`	`boolean`	نه	—
`status`	`string<active, paused>`	نه	—
`allowed_origins`	`string[]`	نه	—
`monthly_message_cap`	`integer`	نه	—

ځواب

نوم	ډول	اړین	دا څه شی دی
`id`	`string`	هو	—
`site_id`	`string`	نه	—
`name`	`string`	هو	What the agent calls itself to visitors. The customer's brand, not ours.
`greeting`	`string`	نه	—
`persona`	`string`	نه	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`	نه	—
`launcher_position`	`string<left, right>`	نه	—
`status`	`string<active, paused>`	هو	`paused` stops it answering and keeps everything it has learned, so switching back on is instant rather than a re-index.
`handoff_enabled`	`boolean`	نه	Offer to pass the visitor to a person when the agent cannot answer.
`public_key`	`string`	هو	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[]`	هو	Origins the public endpoints will answer for. ⛔ Empty refuses everything — it means "not installed yet", never "allow anything".
`monthly_message_cap`	`integer`	نه	Messages included per calendar month. Checked before each answer.
`messages_this_month`	`integer`	نه	—
`indexed_chunks`	`integer`	نه	Passages of the site currently searchable. Zero means it knows nothing yet.
`embed_snippet`	`string`	نه	The two lines to paste into any website.
`sources`	`ChatAgentSource[]`	هو	—

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 422

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