Skip to main content
By the end of this page, you’ll have:
  1. ✅ Minted a personal access token from your Caplia settings
  2. ✅ Hit /v1/health to confirm auth works
  3. ✅ Submitted a pitch deck via POST /v1/decks
  4. ✅ Polled the resulting job until the company appears with its CRI score
Total time: about three minutes. You’ll need a terminal with curl.

Step 1 - Create an API key

In the Caplia portal, go to Settings → API Keys → Create new key:
  1. Give it a name (e.g. “CRM integration”, “Zapier test”)
  2. Choose scope: pick write if you’re sending decks; read is enough for read-only integrations
  3. Click Create
You’ll see the plaintext key exactly once - it looks like:
Copy it somewhere safe. If you lose it, you’ll need to revoke and create a new one - Caplia never stores the plaintext.
Set it as an environment variable in your shell so the rest of this guide is copy-paste-able:

Step 2 - Confirm the key works

The /v1/health endpoint doesn’t require auth, but it’s a useful first check:
Response
Now try an authenticated request - list companies in your pipeline:
Response
If you see a 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)
The response comes back fast - the actual processing happens asynchronously. All fields besides file are optional but help the worker create a cleaner company record:
  • founder_name / founder_email become the company’s contact card.
  • properties tags 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 with GET /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 through queued → processing → completed. Poll every 3 seconds:
Early in the job lifecycle:
Once the company has been created (typically 10-30 seconds in):
When scoring completes (typically 1-2 minutes in):
Surface 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.