hosting

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

Switch on the chat agent for this site.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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