Sign in
CLATRA Flash

Hand it off through the API

Upload the photos, hand off the work, and get the result as JSON when it’s done.

Work handed off through the API is kept as a project, as it is on screen, and comes off the same balance.

  1. Create a key

    Sign in and create one under “API keys” in the left menu. Each person has one key per workspace.

    Every request carries the key in an Authorization: Bearer header. The code below reads the key and the address from these two lines.

    shell
    export FLOW_API_KEY="<api_key>"
    export FLOW_URL="https://flow.unblanq.com"
  2. Upload photos

    Call once for each photo, with slot set to vehicle_images. Keep the descriptor from each answer.

    It takes PNG, JPEG, WebP, HEIC and HEIF, up to 50MB a photo and 120 photos in one hand-off. An uploaded photo is kept until the expires_at in its descriptor.

    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. Hand it off

    Put the descriptor of each photo in vehicle_images and send. idempotency_key is your own reference for this request.

    Use result.run_id from the answer to check the status, and result.admission.target_id to find the result.

    Send the same idempotency_key with the same inputs again within 24 hours, and nothing new is handed off: you get the first answer back (deduplicated: true). If the inputs differ, it is refused with 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": "Claim received Oct 22",
          "output_locale": "en-US"
        },
        "idempotency_key": "request-001"
      }'
  4. Check the status

    Call it every few seconds until the work ends. It has ended when status is one of succeeded, failed, cancelled.

    If it failed, public_errors says why.

    curl
    curl "$FLOW_URL/v1/runs/<run_id>" \
      -H "Authorization: Bearer $FLOW_API_KEY"
  5. Get the result

    The result is kept as a project. First find, in the list, the record_id of the item whose record_key is your target_id. If it isn’t on the first page, put the answer’s next_cursor in cursor for the next page.

    Read with that record_id, and the result comes back as JSON at once (result.record.content). Never put the target_id where the record_id goes.

    curl
    # 1. List: the record_id of the item whose record_key is your target_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. Read: the result (JSON) is in 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>"}}'

What you sendanalyze_vehicle_damage

NameTypeRequiredDescription
output_locale stringminLength: 2 No The language the result explanations are written in. If you don’t send it, they’re written in Korean (ko-KR).
project_id stringminLength: 1 Yes The project’s reference.
request_id stringminLength: 1 Yes This request’s reference.
title string No The name of the result project. Leave it empty and Flow names it.
vehicle_images arrayminItems: 1 · maxItems: 120 · items: object Yes Photos of the accident vehicle. Put in the descriptor from each upload.

You don’t need to send project_id or request_id: Flow fills them in from idempotency_key.

CLATRA Flash

Hand it off now