Loading documentation...

Loading Settler...

API Product Surface

API reference (truthful, tenant-safe)

Settler APIs expose deterministic run execution, evidence retrieval, replay, and health posture. Contracts are designed for operator workflows and audit handoff, not dashboard theatre.

Download v1 OpenAPI Console API schema

Integration baseline

Minimum contract expectations before first production call.

• Authenticate with tenant-scoped API keys via X-API-Key.

• Send Idempotency-Key on run creation to prevent duplicate financial actions.

• Expect RFC7807-style problem responses and machine-readable code values.

• Use x-request-id for support escalation and run-level traceability.

Core endpoints

POST

/api/v1/runs

Create reconciliation run

Creates a tenant-scoped run. Requires Idempotency-Key and returns canonical run identifiers for downstream evidence and replay.

GET

/api/v1/runs

List runs

Returns deterministic lifecycle, summary semantics, and provenance metadata for each run in the authenticated tenant.

GET

/api/v1/runs/{id}

Get run detail

Provides canonical run/detail truth for a single run, including status labeling and machine-readable contract fields.

GET

/api/v1/runs/{id}/evidence

Fetch evidence payload

Returns replay- and support-safe evidence artifacts for audit, operator handoff, and downstream control workflows.

POST

/api/v1/runs/{id}/replay

Replay run

Re-executes a prior run contract to verify deterministic behavior and produce fresh traceable output.

GET

/api/v1/health | /api/v1/ready | /api/v1/meta

Health and posture probes

Use liveness, readiness, and metadata probes to decide when to route traffic and surface explicit degraded states.

Create run

curl -X POST "https://your-host/api/v1/runs" \
  -H "X-API-Key: set_live_***" \
  -H "Idempotency-Key: run-2026-04-close-001" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "April close - Stripe vs Bank",
    "sourceAdapter": "stripe",
    "targetAdapter": "bank_csv",
    "rules": []
  }'

Fetch evidence

curl "https://your-host/api/v1/runs/<run_id>/evidence" \
  -H "X-API-Key: set_live_***"

Loading documentation...

API Product Surface

API reference (truthful, tenant-safe)

Settler APIs expose deterministic run execution, evidence retrieval, replay, and health posture. Contracts are designed for operator workflows and audit handoff, not dashboard theatre.

Download v1 OpenAPI Console API schema

Integration baseline

Minimum contract expectations before first production call.

• Authenticate with tenant-scoped API keys via X-API-Key.

• Send Idempotency-Key on run creation to prevent duplicate financial actions.

• Expect RFC7807-style problem responses and machine-readable code values.

• Use x-request-id for support escalation and run-level traceability.

Core endpoints

POST

/api/v1/runs

Create reconciliation run

Creates a tenant-scoped run. Requires Idempotency-Key and returns canonical run identifiers for downstream evidence and replay.

GET

/api/v1/runs

List runs

Returns deterministic lifecycle, summary semantics, and provenance metadata for each run in the authenticated tenant.

GET

/api/v1/runs/{id}

Get run detail

Provides canonical run/detail truth for a single run, including status labeling and machine-readable contract fields.

GET

/api/v1/runs/{id}/evidence

Fetch evidence payload

Returns replay- and support-safe evidence artifacts for audit, operator handoff, and downstream control workflows.

POST

/api/v1/runs/{id}/replay

Replay run

Re-executes a prior run contract to verify deterministic behavior and produce fresh traceable output.

GET

/api/v1/health | /api/v1/ready | /api/v1/meta

Health and posture probes

Use liveness, readiness, and metadata probes to decide when to route traffic and surface explicit degraded states.

Create run

curl -X POST "https://your-host/api/v1/runs" \
  -H "X-API-Key: set_live_***" \
  -H "Idempotency-Key: run-2026-04-close-001" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "April close - Stripe vs Bank",
    "sourceAdapter": "stripe",
    "targetAdapter": "bank_csv",
    "rules": []
  }'

Fetch evidence

curl "https://your-host/api/v1/runs/<run_id>/evidence" \
  -H "X-API-Key: set_live_***"