# Batch enrichment

Bulk enrichment jobs: create, check status, resume, and download results.

## Create Batch Enrichment

 - [POST /public/v1/enrichment/batch/](https://docs.influencers.club/openapi/batch-enrichment/public_v1_enrichment_batch_create.md): Create a batch enrichment job by uploading a CSV.

How it works
1. Upload a .csv file (one column: handle or email)
2. Choose the enrichment mode (handle: raw/full, email: basic/advanced)
3. Use the returned batch_id to check status and download results

Request
- multipart/form-data
- file: CSV (max 10MB)
- Mode fields depend on whether you’re enriching by handle or email

Credits
- Credits are deducted per successfully enriched record
- The credit rate follows the corresponding single-enrichment mode (raw/full/basic/advanced)
- If no data is returned for a record, 0 credits are deducted for that record

Checking completion
Poll GET /public/v1/enrichment/batch/{batch_id}/status/ every 30–60 seconds until the job finishes. Status values:
- queued — waiting to start
- processing — actively enriching records
- finished — all records done; download results via GET /public/v1/enrichment/batch/{batch_id}/
- failed — job failed
- paused_insufficient_credits — top up credits and call the resume endpoint

This API is polling-based. There are no webhooks or push notifications.

## Download Batch Enrichment Results

 - [GET /public/v1/enrichment/batch/{batch_id}/](https://docs.influencers.club/openapi/batch-enrichment/public_v1_enrichment_batch_retrieve.md): Download the final enriched dataset after processing is complete.

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
- 400 Bad Request — batch not completed yet or no results file available
- 404 Not Found — invalid batch ID or batch does not belong to client

Credits
- 0 credits (download only)

## Resume Batch Enrichment

 - [POST /public/v1/enrichment/batch/{batch_id}/resume/](https://docs.influencers.club/openapi/batch-enrichment/public_v1_enrichment_batch_resume_create.md): Resume a paused or interrupted batch enrichment job.

When to use
- If a batch was paused or failed mid-run and needs to continue processing

Credits
- 0 credits to resume (credits apply only to successfully enriched records)

## Get Batch Enrichment Status

 - [GET /public/v1/enrichment/batch/{batch_id}/status/](https://docs.influencers.club/openapi/batch-enrichment/public_v1_enrichment_batch_status_retrieve.md): Check the current processing status of a batch enrichment job.

What you get
- Current state (e.g., queued/running/completed/failed)
- Progress indicators (processed vs remaining), when available

Credits
- 0 credits (status only)