API로 맡기기
사진을 올리고, 맡기고, 끝나면 결과 파일을 받습니다.
API로 맡긴 일도 화면에서 맡긴 일처럼 프로젝트로 남고, 같은 잔액에서 빠집니다.
-
키 만들기
로그인한 뒤 왼쪽 메뉴의 「API 키」에서 만듭니다. 키는 작업 공간마다 한 사람에 하나입니다.
모든 요청은
Authorization: Bearer머리글에 키를 담습니다. 아래 코드는 키와 주소를 이 두 줄에서 읽습니다.export FLOW_API_KEY="<api_key>" export FLOW_URL="https://flow.unblanq.com" -
사진 올리기
사진 한 장마다 한 번 부릅니다.
slot은source_images이고, 답의descriptor를 모아 둡니다.PNG·JPEG·WebP 형식을 한 건에 1,000장까지 받습니다. 올린 사진은
descriptor의expires_at까지 보관됩니다.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>" -
맡기기
모아 둔
descriptor를source_images에 넣어 보냅니다.idempotency_key는 내가 정해 이 요청에 붙이는 번호입니다.답의
result.run_id로 상태를 보고,result.admission.target_id로 결과를 찾습니다.같은
idempotency_key와 같은inputs로 24시간 안에 다시 보내면 새로 맡기지 않고, 처음 맡긴 일의 답을 다시 줍니다(deduplicated: true).inputs가 다르면 409로 거절합니다.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" }' -
상태 보기
끝날 때까지 몇 초마다 부릅니다.
status가succeeded·failed·cancelled가운데 하나가 되면 끝난 것입니다.failed면public_errors에 까닭이 옵니다.curl "$FLOW_URL/v1/runs/<run_id>" \ -H "Authorization: Bearer $FLOW_API_KEY" -
결과 받기
결과는 프로젝트로 남습니다. 먼저 목록에서
record_key가target_id인 항목의record_id를 찾습니다. 첫 쪽에 없으면 답의next_cursor를cursor에 넣어 다음 쪽을 봅니다.그
record_id로 읽으면 결과 파일 목록이result.outputs로 옵니다. 받을 파일의record_id와revision_id를 고릅니다.target_id를record_id자리에 넣지 않습니다.내려받기에는 프로젝트의
record_id, 고른 파일의record_id(output_record_id)와revision_id를 넣습니다. 답의result.download_url을 같은 키로 부르면 파일을 받습니다.# 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. 내려받기: 파일의 주소는 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(기본), 상품 페이지 주소는 product_page입니다. |
product_name |
object |
아니요 | 상품명 표기입니다. 적는 방법은 brand_name과 같습니다. |
product_page_url |
string |
아니요 | image_source가 product_page면 꼭 넣는 상품 페이지 주소입니다. |
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로 채웁니다.