hosting

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

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

प्रमाणीकरण

बेअरर टोकन म्हणून API की पाठवा. या एंडपॉईंटने स्पष्टीकरणामध्ये ठराविक परवानगी नमूद केलेली नाही, त्यामुळे तुमच्या कीला आवश्यक तेवढाच कमीत कमी ॲक्सेस द्या आणि गृहीत धरण्याऐवजी प्रतिसाद तपासा.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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

साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील API कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह 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