Developers

API reference

Every operation of the public API, drawn from its OpenAPI document. A field or an endpoint appears here the day it ships.

LedgerIt API · Version 1.0.0 · OpenAPI document

Authenticate with an API key from Settings: Authorization: Bearer ll_…. A key acts as the member who made it, in the books it was made in. Errors are {"error": {"type", "code", "message", "param", "request_id"}}; branch on code. Creating calls take an Idempotency-Key, so a retry never writes twice.

Base URL

Every path below is relative to it.

https://api.ledgerit.ai

Conventions

Authentication
Send an API key from Settings as a bearer token. A key acts as the member who made it, in the books it was made in, with that member's role.
Which books
A key reaches its own books. A session that opens several sets of books names one with the X-Entity-Id header.
Retries
Operations marked idempotent take an Idempotency-Key header. Retrying with the same key returns the first answer instead of writing twice. Keys are kept for 24 hours.
Errors
Every failure carries the same envelope. Branch on code, which is stable; message is for people.
Errors
{
  "error": {
    "type": "invalid_request_error",
    "code": "…",
    "message": "…",
    "param": null,
    "request_id": "…"
  }
}

Resources

One page per resource, each operation with its parameters, body, response and an example.