로그인
CLATRA Flash

API로 맡기기

사진을 올리고, 맡기고, 끝나면 결과를 JSON으로 받습니다.

API로 맡긴 일도 화면에서 맡긴 일처럼 프로젝트로 남고, 같은 잔액에서 빠집니다.

  1. 키 만들기

    로그인한 뒤 왼쪽 메뉴의 「API 키」에서 만듭니다. 키는 작업 공간마다 한 사람에 하나입니다.

    모든 요청은 Authorization: Bearer 머리글에 키를 담습니다. 아래 코드는 키와 주소를 이 두 줄에서 읽습니다.

    shell
    export FLOW_API_KEY="<api_key>"
    export FLOW_URL="https://flow.unblanq.com"
  2. 사진 올리기

    사진 한 장마다 한 번 부릅니다. slot은 vehicle_images이고, 답의 descriptor를 모아 둡니다.

    PNG·JPEG·WebP·HEIC·HEIF 형식을 한 장에 50MB까지, 한 건에 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": "ko-KR"
        },
        "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). target_id를 record_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

바로 맡기기