ログイン
Image Localization Studio

API で任せる

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

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 は source_images にし、レスポンスの descriptor を集めておきます。

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

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

    集めた descriptor を source_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%3Aproduct_detail_translation_studio/actions/generate_product_detail_translation/runs" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "inputs": {
          "image_source": "upload",
          "source_images": [<descriptor>, <descriptor>],
          "target_language": "30代の日本のお客様に親しみやすい日本語で"
        },
        "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 で読み込むと、結果のファイルの一覧が result.outputs で返ってきます。受け取るファイルの record_id と revision_id を選びます。record_id の代わりに target_id を入れないでください。

    ダウンロードには、プロジェクトの record_id、選んだファイルの record_id(output_record_id)と revision_id を入れます。レスポンスの result.download_url を同じキーで呼び出すと、ファイルを受け取れます。

    curl
    # 1. 一覧:record_key が target_id の項目の record_id
    curl -X POST \
      "$FLOW_URL/v1/agencies/agency%3Aproduct_detail_translation_studio/actions/list_product_detail_translation_projects/runs" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"inputs": {"relation": "owned", "limit": 50}}'
    
    # 2. 読み込み:結果のファイルの一覧は result.outputs
    curl -X POST \
      "$FLOW_URL/v1/agencies/agency%3Aproduct_detail_translation_studio/actions/read_product_detail_translation_project/runs" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"inputs": {"record_id": "<record_id>"}}'
    
    # 3. ダウンロード:ファイルの URL は result.download_url
    curl -X POST \
      "$FLOW_URL/v1/agencies/agency%3Aproduct_detail_translation_studio/actions/download_product_detail_translation_version/runs" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "inputs": {
          "record_id": "<record_id>",
          "output_record_id": "<output_record_id>",
          "revision_id": "<revision_id>",
          "output_format": "png"
        }
      }'
    
    # 4. ファイルの受け取り:$FLOW_URL のあとに download_url
    curl -L "$FLOW_URL<download_url>" \
      -H "Authorization: Bearer $FLOW_API_KEY" \
      -o <filename>

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

名前形式必須説明
brand_name object いいえ ブランド名の表記です。原文(source_text)と方式(mode:keep そのまま、exact 決めた表記、auto 翻訳)を書き、exact なら exact_target_text も書きます。
image_source stringenum: "upload", "product_page" いいえ 元画像をどこから取るかです。アップロードした画像なら upload(標準)、商品ページの URL なら product_page です。
product_name object いいえ 商品名の表記です。書き方は brand_name と同じです。
product_page_url string いいえ image_source が product_page なら必ず入れる商品ページの URL です。
project_id stringminLength: 1 はい プロジェクトの番号です。
request_id stringminLength: 1 はい このリクエストの番号です。
schema_version string いいえ 入力形式のバージョンです。送らなくても構いません。
source_images arrayminItems: 1 · maxItems: 1000 · items: object いいえ 翻訳する商品詳細画像で、image_source が upload なら必ず入れます。アップロードで受け取った descriptor を順番に入れます。
source_layout_mode stringenum: "independent_sections", "continuous_fragments" いいえ 画像が長いページを分けた断片なら continuous_fragments、それぞれ独立していれば independent_sections(標準)です。
target_language stringminLength: 1 · maxLength: 320 はい 翻訳先の言語と口調を文章で書きます。

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

Image Localization Studio

今すぐ任せる