> ## Documentation Index
> Fetch the complete documentation index at: https://docs.originalis.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Programmatic access to your firm's Originalis workspace — one API key, one base URL, plain JSON.

The Originalis API gives your firm programmatic access to everything your
workspace already knows: the deal pipeline, portfolio book, LP fund
positions, and the network intelligence your team's own emails and
calendars actually evidence — plus the analysis pipelines themselves,
invocable on demand.

Every `GET` is a pure read. The only endpoints that change anything are the
explicit `POST` **actions** (deal, founder, and research analysis) and
webhook management — write-scoped, budgeted, always asynchronous.

## What you can do

<Columns cols={2}>
  <Card title="Query your workspace" icon="database" href="/quickstart">
    Deals, portfolio companies with operating metrics, LP positions and
    cashflows — offset- or cursor-paginated, warehouse-ready.
  </Card>

  <Card title="Ask your network" icon="users" href="/guides/recipes">
    Who do we know at a company, relationship warmth for any contact,
    going-stale signals — every path names the teammate who owns it.
  </Card>

  <Card title="Run analysis" icon="bolt" href="/guides/actions">
    Submit a website, a DocSend link, or a deck file; run founder
    assessments and deep research. `202` now, poll or stream to done.
  </Card>

  <Card title="Get pushed results" icon="webhook" href="/guides/webhooks">
    Signed webhooks (Standard Webhooks scheme) on every terminal event,
    with a delivery ledger for debugging.
  </Card>
</Columns>

## Principles

* **Your data, your scope.** Every response is scoped to your org and
  declares that scope explicitly. Warm paths pool only across teammates
  who opted into network sharing.
* **Absence is honest.** Missing data comes back as `null` plus a typed
  `unavailable_reason` — never a defaulted or invented figure.
* **Reads are pure; actions are explicit.** `GET` never mutates or
  spends. Actions require a write-scoped key and a separate daily budget.
* **Stable contract.** The `/api/v1` surface changes additively only:
  fields are added, never renamed, retyped, or removed.

## Base URL

```text theme={null}
https://api.originalis.ai/api/v1
```

The machine-readable contract lives at
[`/api/v1/openapi.json`](https://api.originalis.ai/api/v1/openapi.json) (OpenAPI 3.1,
unauthenticated) — point Stainless, Speakeasy, Fern, or
`openapi-generator` at it for a typed client.
