hosting

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

The AI chat agent on this site — how it is configured and what it knows.

ማረጋገጫ

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

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

ሞክሩት

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

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
  -H "Authorization: Bearer zdk_live_…"

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

ዝርዝሮች

The agent's name, personality, colours, the domains it may be embedded on, what it has read, how many messages it has answered this month, and the snippet to paste into a site we do not host. 404 when this site has no agent. Buying ai_chat_agent from the add-on store creates one; so does POST to this path once the product is owned.

መለኪያዎች

ስም	ዓይነት	የሚያስፈልግ	ምንነቱ
`siteId (path)`	`Uuid`	አዎ	Site ID (UUIDv7).

ምላሽ

ስም	ዓይነት	የሚያስፈልግ	ምንነቱ
`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

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