hosting

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

Switch on the chat agent for this site.

Πισtoποίηση

Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Αυτό το τελικό σημείο δεν ορίζει μια συγκεκριμένη άδεια στην προδιαγραφή, οπότε δώστε στο κλειδί σας τα ελάχιστα δυνατά δικαιώματα και ελέγξτε την απόκριση αντί να κάνετε υποθέσεις.

Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.

Δοκιμάστε το

Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.

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.

Παράμετροι

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`siteId (path)`	`Uuid`	Ναι	Site ID (UUIDv7).

Σώμα αίτησης

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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`	Όχι	—

Απάντηση

Όνομα	Τύpος	Υποχρεωτικό	Τι είναι
`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