API Usage FAQ

The limit is 30 requests per minute per API key. Above that the API returns 429 with the code rate_limited. Space requests out and back off when you receive a 429. For batch work, queue your files and process them at a controlled rate. If the parser is at capacity it returns 503 with the code busy; retry after a short wait. If you need more throughput, contact us.

There are two. POST /v1/parse takes a PDF in the multipart field file and returns the parsed JSON in the same response. GET /v1/usage returns this month's successful parses, free parses remaining and credit balance for your account. Both use your API key and are called from your backend.

A successful response is { data, usage }. data holds the parsed resume: firstName, lastName, emailAddress, phoneNumber, location, locationCity, locationState, locationCountry, linkedInLink, workExperiences, educations, fluentLanguages and languages. usage holds billedAs (free or credit), freeRemaining and creditBalance. Every field in data is optional, so check for missing fields before using them.

Errors return a JSON body { error: { code, message } }. 400 invalid_file: the file is missing or not a PDF. 401 invalid_api_key: the key is missing, wrong or revoked. 402 insufficient_credits: the free parses for the month are used and there are no credits. 413 file_too_large: the file is over 5 MB. 429 rate_limited: more than 30 requests per minute. 422 parse_failed: the PDF has no text layer. 503 busy: retry later. For 400, 401 and 413, fix the request; retrying the same request will not succeed.

The maximum file size is 5 MB, and the only supported format is PDF. Send the file as multipart/form-data in the field named file. If a resume is larger than 5 MB it usually contains high-resolution images; re-export it with compressed images. The API returns 413 file_too_large if the file exceeds the limit.

A parse can take up to 60 seconds. The API is synchronous, so set your HTTP client timeout to at least 60 seconds. The response includes the full parsed data; there is nothing to poll.

Yes. The API is a standard HTTPS endpoint that works from any environment that can make HTTPS requests. Store your API key in the platform's secrets or environment variables. Set the function timeout high enough for a synchronous parse. Concurrent function instances share the 30 requests per minute limit of the key, so use a queue for batch workloads.