Auk

# Auk

Auk is Parametrig's current published API family.

It is the integration surface partners use for programmatic protection flows,
while the console remains a client over the same canonical backend.

## Current Role

- public API family for partner integration
- canonical contract for browser and headless clients
- home for quotes, binds, policy state, claims, and related operational flows

## Integration Loop

- authenticate against the canonical backend
- request a quote or other programmatic protection action
- bind or progress the relevant workflow through the same backend contract
- receive lifecycle changes through API reads and future event/webhook surfaces
- treat browser clients as clients over the same contract, not separate logic

## Authentication Posture

Public Auk integrations should assume:

- authenticated programmatic access
- stable request and response semantics
- explicit versioned contract behavior
- future examples, references, and events published here only when they are
  ready to be treated as durable external interface

## Public Boundary

Public Auk docs should focus on stable external behavior:

- integration model
- authentication and access expectations
- endpoint and event semantics
- examples that are safe to treat as public contract

## Illustrative Request Shape

The exact public reference set will expand later. For now, this example shows
the expected auth and request shape without claiming that the entire internal
surface is already published.

<div class="code-tabs">
  <button class="code-tab active" data-tab="tab-curl">cURL</button>
  <button class="code-tab" data-tab="tab-python">Python</button>
  <button class="code-tab" data-tab="tab-typescript">TypeScript</button>
</div>
<div class="tab-panel active" id="tab-curl">
```bash
curl https://api.parametrig.com/auk/v1/quotes \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "product": "flight_delay",
    "context": {
      "partner": "demo"
    },
    "coverage": {
      "limit": 25000
    }
  }'
```
</div>
<div class="tab-panel" id="tab-python">
```python
import requests

response = requests.post(
    "https://api.parametrig.com/auk/v1/quotes",
    headers={"Authorization": "Bearer <token>"},
    json={
        "product": "flight_delay",
        "context": {"partner": "demo"},
        "coverage": {"limit": 25000},
    },
)
```
</div>
<div class="tab-panel" id="tab-typescript">
```ts
const response = await fetch("https://api.parametrig.com/auk/v1/quotes", {
  method: "POST",
  headers: {
    Authorization: "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    product: "flight_delay",
    context: { partner: "demo" },
    coverage: { limit: 25000 },
  }),
});
```
</div>

## Illustrative Event Shape

As public event guidance expands, it should remain here. This is an example of
the kind of lifecycle artifact partners should expect, without claiming the
entire event catalog is already published.

```json
{
  "type": "policy.updated",
  "product": "flight_delay",
  "policy_id": "pol_123",
  "status": "active",
  "occurred_at": "2026-03-20T10:12:00Z",
  "links": {
    "self": "https://api.parametrig.com/auk/v1/policies/pol_123"
  }
}
```

## What Expands Next

As Auk public docs deepen, this section should grow into:

- authentication guidance
- endpoint and object references
- event and webhook references
- implementation examples
- integration caveats and operational notes

## Not Yet Public

Future named surfaces can be added alongside Auk when they become real public
contracts. Until then, this docs site should not imply they are launched just
because their names already exist internally.