Build an integration
Connect your recruiting system to analysis, interviews, and evidence-backed results.
Use the ProBB AI API when candidate applications already live in your ATS or another backend. Your system supplies a resume and role; ProBB AI runs analysis, prepares interviews, and returns evidence for your team to review. Webhooks let you react to changes without continuously polling.
Choose your first workflow
Run your first analysis
Upload a resume, request a quote, submit, and retrieve a report.
Invite a candidate
Send an interview invitation and follow candidate and evaluation progress.
Import a batch
Submit multiple applications and recover partial failures safely.
Test in the sandbox
Use synthetic candidates, controlled outcomes, and a signed webhook inbox.
Before you begin
You need an enabled workspace, an Admin who can create an API key, and a backend that can keep credentials private. API access and outbound webhooks are enabled independently. If Developer settings reports that access is unavailable, contact your ProBB AI administrator.
Start with authentication and scopes. Use the sandbox before sending real candidate data. The API is intended for server-to-server integration; the documentation's browser console can call only its configured sandbox.
How the pieces fit together
| Step | Why it exists | Save in your system |
|---|---|---|
| Discover a job | Reuse the workspace's reviewed role requirements | Job ID and revision |
| Prepare and upload | Register the application, then transfer the file securely | Report ID and external reference |
| Quote | Review the assigned configuration and applicable price | Fingerprint for the corresponding submission |
| Submit analysis | Accept work and start asynchronous processing | Attempt ID and status URL |
| Retrieve evidence | Display a completed evaluation for human review | Resource ID, result revision, schema version |
| Invite and evaluate | Add candidate interview evidence | Interview attempt ID |
| Receive events | Update your system when work changes | Verified event ID and recovery cursor |
Quotes do not reserve capacity. A successful submission acknowledges accepted work; it does not guarantee an immediate result. API concepts explains these distinctions.
Find the right reference
The API reference provides purpose, prerequisites, request/response examples, field definitions, and recovery for every operation. Webhook events describes every notification. The OpenAPI download is available for tooling and client generation.
Use external references to connect application IDs, versioned results to consume evidence, and errors and retries to implement recovery. ProBB AI IDs and cursors are opaque; your integration should store them rather than infer their structure.
Production readiness
Before enabling real applications, verify that identical request retries create one logical submission, delayed events cannot overwrite a newer attempt, partial batch failures retain successful IDs, and your receiver verifies signatures before parsing. Keep API keys, signed upload URLs, and invitation credentials out of browser bundles and logs. Use request IDs for support.