hosting

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

Switch on the chat agent for this site.

ማረጋገጫ

የኤፒአይ ቁልፍ (API key) እንደ ቢረር ቶከን (bearer token) ይላኩ። ይህ የመጨረሻ ነጥብ (endpoint) በመግለጫው ውስጥ የተወሰነ ፈቃድ አልገለጸም፣ ስለዚህ ከማሰብ ይልቅ ለቁልፍዎ የሚያስፈልገውን አነስተኛ ፈቃድ ይስጡት እና ምላሹን ያረጋግጡ።

ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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

ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በ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