Blue-IQ Capture API

Three calls: get a key, submit a file, poll until it is done.

# 1. Submit
curl -X POST "https://api.parsinglab.blue-iq.ai/api/v1/resume/parse" \
  -H "X-API-Key: rp_live_your_key" \
  -F "file=@resume.pdf"

# -> { "job_id": "01J3K...", "status": "processing",
#      "poll_url": "/api/v1/resume/job/01J3K..." }

# 2. Poll until status is terminal
curl "https://api.parsinglab.blue-iq.ai/api/v1/resume/job/01J3K..." \
  -H "X-API-Key: rp_live_your_key"

Generate a key in the dashboard. It is shown once, so copy it then. Use it only from your server.

Every request carries your key in the X-API-Key header. There are no other auth schemes on the parsing endpoints.

X-API-Key: rp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

POST /api/v1/resume/parse with multipart/form-data and one file field. Accepts PDF, DOCX, RTF, PNG, JPG and TIFF up to 10 MB.

curl -X POST "https://api.parsinglab.blue-iq.ai/api/v1/resume/parse" \
  -H "X-API-Key: rp_live_your_key" \
  -F "file=@resume.pdf" \
  -F "force_textract=false"

The response is immediate and never contains the parsed record:

{
  "job_id":   "01J3K5M2N4P6Q8R0S2T4U6V8W0",
  "status":   "processing",
  "poll_url": "/api/v1/resume/job/01J3K5M2N4P6Q8R0S2T4U6V8W0"
}

GET /api/v1/resume/job/{job_id} until status is terminal. A sensible loop polls every 2 seconds and gives up after a couple of minutes.

A completed job returns the record under data, per-section scores under confidence, and any caveats under warnings.

{
  "job_id": "01J3K...",
  "status": "completed",
  "data": {
    "personal_info": { "full_name": "Jane Smith", "email": "jane@example.com",
                       "phone": "865-541-1111", "credentials": ["RN", "BSN"] },
    "experience": [
      { "company": "Fort Sanders Regional Medical Center",
        "role": "RN - Med Surg/Tele",
        "start_date": "01/2022", "end_date": "Present",
        "city": "Knoxville", "state": "TN", "state_id": "42",
        "profession": "RN", "profession_id": "1",
        "specialties": [
          { "name": "Med Surg/Tele", "specialty_id": "88", "confidence": 1.0 }
        ],
        "description": ["Charge nurse on a 30-bed telemetry unit"] }
    ],
    "education":      [{ "institution": "University of Tennessee",
                         "degree": "BSN", "graduation_year": 2021 }],
    "certifications": [{ "name": "BLS", "issued_date": "01/2024" }],
    "licenses":       [{ "license_type": "RN", "state": "TN", "is_compact": true }]
  },
  "confidence": { "overall": 0.9, "experience": 1.0, "catalog_mapping": 0.8 },
  "partial": false,
  "warnings": []
}

Reading the scores

Each specialty, profession and location resolves to a platform id with its own confidence. An unresolved id comes back null rather than a guess, so routing on specialty_id === null is a reliable review trigger.

For anything near the request limit, upload straight to storage and hand back the key. Two calls: ask for a presigned URL, PUT the bytes, then parse it.

# 1. Ask for somewhere to put it
curl -X POST "https://api.parsinglab.blue-iq.ai/api/v1/resume/upload-url" \
  -H "X-API-Key: rp_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"filename":"scan.pdf"}'

# 2. PUT the bytes at the returned URL, then:
curl -X POST "https://api.parsinglab.blue-iq.ai/api/v1/resume/parse-uploaded" \
  -H "X-API-Key: rp_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"upload_id":"..."}'

POST /api/v1/resume/batch takes up to 200 files, or 60 MB across the whole request, whichever comes first. It returns 202 with a batch_id; poll GET /api/v1/resume/batch/{batch_id} for per-file status.

curl -X POST "https://api.parsinglab.blue-iq.ai/api/v1/resume/batch" \
  -H "X-API-Key: rp_live_your_key" \
  -F "files=@one.pdf" -F "files=@two.docx"

Register an endpoint and skip polling entirely. Every active endpoint receives every event, and each registration gets its own signing secret.

curl -X POST "https://api.parsinglab.blue-iq.ai/api/v1/webhooks" \
  -H "X-API-Key: rp_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://your-app.example.com/hooks/capture"}'

Verifying a delivery

Each request carries three headers. Recompute the signature over the raw body:

POST /api/v1/resume/{job_id}/retry re-runs a parse, for a job that failed on something transient. Repeated retries return RETRY_LIMIT_REACHED.

POST /api/v1/resume/{job_id}/feedback sends corrections back and returns 202. Corrections a reviewer makes are what improve extraction over time, so it is worth wiring up if you have a review step.

Every error returns the same shape, with a stable machine-readable code. Branch on the code, not the message.

{
  "error": {
    "code": "UNSUPPORTED_FILE_TYPE",
    "detail": "Only PDF, DOCX, RTF, PNG, JPG and TIFF are accepted."
  }
}

GET /api/v1/health reports service status and dependency health (DynamoDB, S3, the async worker) if you want to monitor it.