hosting

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

Switch on the chat agent for this site.

모든 hosting 엔드포인트

모든 개발자 문서 →

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. 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

인증