Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.venture.caplia.ai/llms.txt

Use this file to discover all available pages before exploring further.

This section contains the full reference for every endpoint in v1 of the Caplia API. Each endpoint page has:
  • Path, method, required scope
  • Path / query / body parameters with types
  • Example requests in curl, Node, Python, Go, Ruby
  • Example success and error responses
  • A live “Try it” playground (paste your key, hit run)

Conventions

Base URL

https://api.venture.caplia.ai
All paths shown in this reference are appended to that base.

Authentication

Every endpoint except GET /v1/health and GET /v1/openapi.json requires the Authorization: Bearer cap_inv_live_... header. See Authentication for key format, scopes, and rotation.

Response shape

Success - bare resource (no envelope):
{
  "id": "5a1c...",
  "name": "Tesla",
  ...
}
Error - always envelope-wrapped:
{
  "error": {
    "code": "company_not_found",
    "message": "No company with id abc-123 in your pipeline",
    "request_id": "req_8H3jK9pQ"
  }
}
Always include request_id when contacting support.

Status codes

CodeMeaning
200Read success
201Create success
202Accepted but async - see /v1/jobs/{id} to track
400Bad input (validation)
401Missing or invalid API key
403Key valid, but doesn’t carry the required scope
404Resource not found, or outside your team’s visibility
409Conflict (e.g. duplicate submission)
429Rate limited (not yet enforced in v1)
500Unexpected server error - please report with request_id
We deliberately return 404 rather than 403 when you query a resource you can see structurally but don’t own - this prevents enumeration of other teams’ data.

Pagination

Endpoints that return lists support cursor-based pagination:
curl "https://api.venture.caplia.ai/v1/companies?limit=50&cursor=Y3Vyc29yX2RhdGE="
When more results are available, the response includes a next_cursor:
{
  "data": [ /* ... */ ],
  "next_cursor": "Y3Vyc29yX2RhdGE="
}
Pass that value back as cursor to fetch the next page. Default limit is 25, max is 100.

OpenAPI spec

The machine-readable spec lives at:
https://api.venture.caplia.ai/v1/openapi.json
You can pipe this into Postman, Insomnia, or any OpenAPI-aware tool. It’s regenerated automatically from the live API on every deploy, so it’s always in sync with what the server actually does.

Endpoints by category

Companies

List, get, create, search companies in your pipeline.

Scores & metrics

CRI scores, thesis matches, traction metrics, key metrics.

Data rooms

List folders, documents; get signed download URLs; upload new documents.

Deck intake

Submit pitch decks; poll job status; receive enriched results.

Theses & views

Your team’s investment theses and pipeline view configurations.

Health & meta

Liveness check and machine-readable OpenAPI spec.
Use the sidebar to jump to a specific endpoint.