hosting

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

Switch on the chat agent for this site.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

Creates the agent, named after the site and pre-authorised for the site's own domains so the snippet works the moment it is pasted. ⛔ Refuses with 422 when the product has not been bought for this site, or when the account is not in good standing — two different refusals with two different remedies, told apart by the code in the error details (not_purchased / not_in_good_standing). A suspension is not cleared by credit, so that refusal deliberately offers no top-up. Calling it twice returns the existing agent with 200 rather than an error.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`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

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