Search
index済み動画を検索
POST
/api/v1alpha1/search自然言語のqueryでindex済みの動画を検索し、scoreと、存在する場合は再生可能なmedia URLを添えて、関連度順の結果を返します。
- アクセス: alphaを有効にしたAPI keyと
SEARCH_CONTENT権限。 - 範囲:
video_idsを指定すると対象を限定できます。ワークスペースから見えないidが1つでもあると、リクエスト全体が404になります。 - 調整:
limitの既定値は25で、範囲は1から100。thresholdの既定値は0.7で、範囲は0から1。
結果のvideo_idをGET /api/v1alpha1/videos/{video_id}に渡して処理状態を確認するか、media URLを開いて内容を確認してください。
認証
apiKey 認証Bearer <token>
場所: header
リクエストボディ
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/search" \ -H "Authorization: Bearer $DEEPFRAME_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "limit": 10, "query": "person entering through the north door", "threshold": 0.82, "video_ids": [ "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" ] }'{ "data": [ { "id": "vid_0190b5d4_frame_0042", "image": "https://cdn.example.test/media/vid_0190b5d4/frame-0042.jpg", "scene_description": "A person enters through the north door.", "score": 0.94, "tags": [ "person", "north door" ], "time_position": 222000, "title": "warehouse-inspection-2026-08-08.mp4", "video_id": "vid_0190b5d4-7e1f-7a2b-9c3d-1234567890ab", "video_url": "https://cdn.example.test/media/vid_0190b5d4/video.mp4" } ], "has_more": false, "next_cursor": "MDEyMzQ1Njc4OWFitSLKnTQIcJAwDPi07V5EGs76Im3F8rCuUshrBnHuUJY7_8Ie8Stea_TKuhKhDw5XkRdkBI3IKkvsKT9Kp60Wpx7CoTCGQW8FnalDILVbuy8wxvWWf_B8SA"}