Batch enrichment

Download Batch Enrichment Results (Direct)

Changed on

Download the final enriched dataset after processing is complete.

Tip: For CSV downloads, consider using the recommended endpoint GET /public/v1/enrichment/batch/{batch_id}/download/ instead — it returns a presigned URL for faster, more reliable downloads. Use this endpoint if you need JSON output or as a fallback.

Requirements

  • Batch must be in finished status
  • Results file must have been generated

Output formats

  • CSV (default) — omit format or pass ?format=csv
  • JSON — pass ?format=json to receive a JSON array where each object has:   - input_value — the original input (handle or email)   - status — enrichment status for that record   - enrichment_data — the enriched creator data

Error Responses

Every error response shares the canonical shape {"error": <message>, "error_code": <slug>, ...}. Branch programmatically on error_code rather than parsing error.

  • 400 Bad Request (error_code: "batch_not_ready") — batch not completed yet; current_status is included in the body
  • 400 Bad Request (error_code: "no_results") — batch finished but produced no rows
  • 400 Bad Request (error_code: "results_not_ready") — batch finished but the results file is still being assembled
  • 404 Not Found (error_code: "batch_not_found") — invalid batch ID or batch does not belong to client
  • 500 Server Error (error_code: "service_error") — results file could not be retrieved from storage; safe to retry

Credits

  • 0 credits (download only)
<div class="ic-ai-prompt-root" data-endpoint="batch-download"></div>
get/public/v1/enrichment/batch/{batch_id}/

Request

Path parameters

batch_idstring required

Unique batch identifier returned when creating the enrichment batch

Query parameters

format'csv' | 'json'

Output format. Omit or pass csv (default) to receive a CSV file. Pass json to receive a JSON array of objects with input_value, status, and enrichment_data fields.

Response

CSV or JSON file with enriched results depending on the format query parameter.

input_valuestring
statusstring
enrichment_dataobject

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status