ai
POST /v1/ai/site-agent/sites/{site_id}/check
Read this site's server, diagnose it, and fix what the customer allows.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/ai/site-agent/sites/{site_id}/check \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Reads the site's live server — error log, PHP faults, slow queries, disk and memory — diagnoses what is wrong, and applies the fixes this customer has allowed to run unattended. Fixes they have asked to be asked about come back in offered with the finding that triggered them, so the screen can show the button. Log text is redacted before it leaves the server: visitor IP addresses, email addresses, tokens, keys and passwords are masked, and logs.sources[].masked reports how many runs of each kind were removed. On our own fleet the server-wide error log is filtered to this account on the host, so another tenant's lines are never transferred at all. A source that could not be read is returned with state: unavailable and a reason, never omitted — "we found nothing wrong" and "we could not look" are different answers and only one of them is reassuring. incomplete is true whenever any source is in that state. Counts against the monthly allowance. A 402 means the allowance is exhausted or the account is not in good standing; the body carries the allowance and a message. Requires sites.view.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
site_id (path) | Uuid | はい | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
site_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source | string<ticket, self_serve, staff> | はい | — |
incomplete | boolean | はい | True when any source could not be read or the diagnosis was partial. |
refused | boolean | はい | — |
refusal_code | string | いいえ | allowance_exhausted or not_in_good_standing. |
refusal_message | string | いいえ | — |
logs | AiSiteAgentLogs | はい | — |
findings | AiSiteAgentFinding[] | はい | — |
applied | object[] | はい | Fixes the AI applied, and under which mode. |
offered | object[] | はい | Fixes found but NOT applied, with why. awaiting_your_approval means the customer asked to be asked; anything else names a refusal. |
allowance | AiSiteAgentAllowance | いいえ | — |
このエンドポイントが返すエラー
401 · 402 · 403 · 404 · 422 · 429