API

リクエスト先 /api/v1 ヘッダー付き Authorization: Bearer uxp_.... アカウントでキーを作成します。制限は1分あたり60リクエストです。

実行開始

curl -X POST $BASE/api/v1/runs \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"site":"SITE_ID","steps":20,"concurrency":3,"personas":["p01","p03"]}'

personasを省略すると、パネルで有効化されているすべてのペルソナが使用されます。レスポンス: {"id":"r...","status":"queued","credits":2}

メソッド

メソッドパス機能
GET/balanceクレジット残高
GET/sitesあなたのサイト、そのID、およびパネル
GET/personasペルソナライブラリ
GET/runs最新のテスト実行
POST/runs実行開始
GET/runs/{id}ペルソナごとのステータスと結果
POST/runs/{id}/cancelキャンセル。未完了のクレジットは返金されます

エラー

形式: {"error":{"code":"...","message":"..."}}

HTTPコード意味
400no_personasペルソナが選択されていないか、またはこのサイトに該当するIDがありません
400not_test_hostテスト決済モードでは、テストホスト上に開始ページが必要です
401unauthorizedキーが見つからない、または無効です
402insufficient_creditsクレジットが不足しています
403domain_not_verifiedドメインが検証されていません
404not_foundアカウントにそのようなデータはありません
409too_many_runsキュー内のテスト実行数が多すぎます
429rate_limitedリクエスト制限を超えました

テスト実行がサイトに与える影響

検証済みドメインへのGETリクエストのみ送信されます。フォームは送信されず、パスワードやカード情報のフィールドは空のままなので、テスト実行は登録、ログイン、決済を行いません。例外はテストホスト用に有効にしたテスト決済モードです。注釈はAIモデルが生成するため、修正する前に必ず確認してください。