Basic Usage
Base URL for all API endpoints:- As a header:
x-api-key: YOUR_API_KEY
- As a query parameter:
?api_key=YOUR_API_KEY
Error Codes
Code | Message | Description |
---|---|---|
200 | OK | Successful response |
400 | Bad Request | Invalid input or malformed request |
401 | Unauthorized | API key missing |
402 | Payment Required | Insufficient credits to process request |
403 | Forbidden | Invalid or unauthorized API key |
500 | Internal Server Error | Unexpected server-side issue |
Credit System
Each successful request (returns data) consumes credits. Credits vary per endpoint.Endpoint-Specific Credit Pools
Some endpoints have dedicated credit pools:- Search operations (
/jobs/<job_id>/search
): May have separate search credit limits - Assessment operations (
/jobs/<job_id>/assess
): May have separate assess credit limits - User lookups (
/user
): Use general credit pool
Credit Verification
Credits are checked before processing your request. If insufficient credits are available:- Request returns
402 Payment Required
status - No data is processed or returned
- No credits are consumed
Response Headers
All successful responses include detailed credit information: Usage Tracking:X-Credits-Used
: Total credits used across all endpointsX-Credits-Used-User
: Credits used for /user endpointX-Credits-Used-Search
: Credits used for /jobs/search endpointX-Credits-Used-Assess
: Credits used for /jobs/assess endpoint
X-Credits-Remaining
: General credits remaining (-1 for unlimited)X-Credits-Remaining-Search
: Search credits remaining (if configured)X-Credits-Remaining-Assess
: Assess credits remaining (if configured)
X-Calls-User
: Total calls to /user endpointX-Calls-Search
: Total calls to /jobs/search endpointX-Calls-Assess
: Total calls to /jobs/assess endpoint
X-Request-Origin
(Optional)
If you pass the X-Request-Origin
header in your request, it will be included in the response headers.This is useful for tracking the origin of your requests (e.g., from a specific frontend app, client ID, or experiment). Example Request:
API Endpoints
User Match Endpoint
Retrieve detailed developer profiles using GitHub, LinkedIn, X (Twitter), or email. Example Request:📬 Need Help or Access?
Contact us at henry@b2d.ai