- ✅ Minted a personal access token from your Caplia settings
- ✅ Hit
/v1/healthto confirm auth works - ✅ Submitted a pitch deck via
POST /v1/decks - ✅ Polled the resulting job until the company appears with its CRI score
curl.
Step 1 - Create an API key
In the Caplia portal, go to Settings → API Keys → Create new key:- Give it a name (e.g. “CRM integration”, “Zapier test”)
- Choose scope: pick
writeif you’re sending decks;readis enough for read-only integrations - Click Create
Step 2 - Confirm the key works
The/v1/health endpoint doesn’t require auth, but it’s a useful first check:
Response
Response
401, double-check the Authorization header - it should be Bearer cap_inv_live_... with a single space between.
Step 3 - Submit a pitch deck
This is the main “push deals in” flow. The deck goes through Caplia’s intake pipeline, gets text-extracted, the company is created, then CRI and thesis scores compute in the background.Response (202 Accepted)
file are optional but help the worker create a cleaner company record:
founder_name/founder_emailbecome the company’s contact card.propertiestags the deal with your team’s custom properties (a JSON object of property → option, e.g. an awards programme’s category). Property names and option labels are configured per team inside Caplia — discover the current values withGET /v1/properties, and prefer submitting the returned ids so internal renames never break your integration. Unknown or archived entries are skipped (with a server-side warning) rather than failing the submission.
The deck file must be a PDF, ≤ 50 MB. Decks submitted via the API auto-approve into your pipeline - the act of holding a scoped API key is sufficient trust.
Step 4 - Poll the job
The job moves throughqueued → processing → completed. Poll every 3 seconds:
results.company as soon as it appears so your users see something useful; layer in results.cri and results.thesis_matches as they land.
What’s next
Authentication details
Key format, scopes, rotation, security best practices.
Full API reference
Every endpoint, every parameter, with try-it-yourself examples.