Rulebooks
rulebookを作成
POST
/api/v1alpha1/rulebooksrulebookを作成します。rulebookは、runが動画を照合するruleの集合で、作成したAPI keyに属します。
- アクセス: alphaを有効にしたAPI keyと
MANAGE_RULEBOOKS権限。 - 再試行: 任意の
Idempotency-Keyにより、再送を安全に扱えます。
POST /api/v1alpha1/workflowsでworkflowに紐付けたうえで、そのworkflowでrunを開始してください。
認証
apiKey 認証Bearer <token>
場所: header
ヘッダーパラメーター
Idempotency-Key?string
このPOSTを安全にretryするための任意のkeyです。keyは24時間保持され、request payloadと具体的なpath parameterと比較されます。
長さ
length <= 255リクエストボディ
application/json
TypeScript 型定義
TypeScript では request body 型を使用します。
レスポンスボディ
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/v1alpha1/rulebooks" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "content": "Inspect every emergency exit.", "name": "Warehouse Safety", "rules": [ { "description": "The exit remains unobstructed.", "id": "SEC-04", "title": "Emergency exit is clear." } ] }'{ "can_delete": true, "can_edit": true, "content": "Inspect every emergency exit.", "created_at": "2026-08-10T10:05:00.000Z", "created_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "has_active_workflow_run": false, "id": "rb_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "is_template": false, "name": "Warehouse Safety", "owner_id": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "rules": [ { "description": "The exit remains unobstructed.", "id": "SEC-04", "title": "Emergency exit is clear.", "version": 2 } ], "template_key": "template_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "updated_at": "2026-08-10T10:06:00.000Z", "updated_by": "user_0190b5d4-7e1f-7a2b-9c3d-1234567890ab"}