ログイン
CLATRA Flash

API で任せる

写真をアップロードして任せ、終わったら結果を JSON で受け取ります。

API で任せた仕事も、画面で任せた仕事と同じようにプロジェクトとして残り、同じ残高から差し引かれます。

  1. キーを作る

    ログインしたあと、左のメニューの「API キー」で作ります。キーは、ワークスペースごとに一人一つです。

    すべてのリクエストは、Authorization: Bearer ヘッダーでキーを送ります。以下のコードは、キーと URL をこの2行から読み込みます。

    shell
    export FLOW_API_KEY="<api_key>"
    export FLOW_URL="https://flow.unblanq.com"
  2. 写真をアップロードする

    写真1枚ごとに1回呼び出します。slot は vehicle_images にし、レスポンスの descriptor を集めておきます。

    PNG・JPEG・WebP・HEIC・HEIF 形式を、1枚あたり 50MB まで、1件につき 120枚まで受け付けます。アップロードした写真は、descriptor の expires_at まで保管されます。

    curl
    curl -X POST \
      "$FLOW_URL/v1/agencies/agency%3Aauto_damage_inspector/actions/analyze_vehicle_damage/uploads" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -F "slot=vehicle_images" \
      -F "file=@<file>"
  3. 任せる

    集めた descriptor を vehicle_images に入れて送ります。idempotency_key は、自分で決めてこのリクエストに付ける番号です。

    レスポンスの result.run_id で状態を確認し、result.admission.target_id で結果を探します。

    同じ idempotency_key と同じ inputs で24時間以内にもう一度送ると、新しく任せず、最初に任せたときのレスポンスをもう一度返します(deduplicated: true)。inputs が違うと、409で断ります。

    curl
    curl -X POST \
      "$FLOW_URL/v1/agencies/agency%3Aauto_damage_inspector/actions/analyze_vehicle_damage/runs" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "inputs": {
          "vehicle_images": [<descriptor>, <descriptor>],
          "title": "10月22日受付の事故",
          "output_locale": "ja-JP"
        },
        "idempotency_key": "request-001"
      }'
  4. 状態を確認する

    終わるまで数秒ごとに呼び出します。status が succeeded・failed・cancelled のどれかになれば終わりです。

    failed なら、public_errors に理由が入ります。

    curl
    curl "$FLOW_URL/v1/runs/<run_id>" \
      -H "Authorization: Bearer $FLOW_API_KEY"
  5. 結果を受け取る

    結果はプロジェクトとして残ります。まず一覧で、record_key が target_id の項目の record_id を探します。最初のページになければ、レスポンスの next_cursor を cursor に入れて次のページを見ます。

    その record_id で読み込むと、結果がすぐに JSON で返ってきます(result.record.content)。record_id の代わりに target_id を入れないでください。

    curl
    # 1. 一覧:record_key が target_id の項目の record_id
    curl -X POST \
      "$FLOW_URL/v1/agencies/agency%3Aauto_damage_inspector/actions/list_auto_damage_projects/runs" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"inputs": {"relation": "owned", "limit": 50}}'
    
    # 2. 読み込み:結果(JSON)は result.record.content
    curl -X POST \
      "$FLOW_URL/v1/agencies/agency%3Aauto_damage_inspector/actions/read_auto_damage_project/runs" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"inputs": {"record_id": "<record_id>"}}'

任せるときに入れるものanalyze_vehicle_damage

名前形式必須説明
output_locale stringminLength: 2 いいえ 結果の説明を書く言語です。送らない場合は韓国語(ko-KR)で書きます。
project_id stringminLength: 1 はい プロジェクトの番号です。
request_id stringminLength: 1 はい このリクエストの番号です。
title string いいえ 結果のプロジェクト名です。空欄にすると、Flow が名前を付けます。
vehicle_images arrayminItems: 1 · maxItems: 120 · items: object はい 事故車両の写真です。アップロードで受け取った descriptor を入れます。

project_id と request_id は送らなくてもかまいません。Flow が idempotency_key をもとに入れます。

CLATRA Flash

今すぐ任せる