API reference

Schemas

A schema is a JSON Schema 2020-12 document (limited to 64 KB serialized) describing the typed output you want. Schemas are reusable across jobs and owned by the tenant.

Create a schema#

POST/v1/schemas

namerequired

string

Display name, 1 to 80 characters.

json_schemarequired

object

A JSON Schema 2020-12 document. Max 64 KB serialized.

description

string | null

Optional, up to 500 characters.

bash

curl -X POST https://api.lirovo.ai/v1/schemas \
  -H "Authorization: Bearer $LIROVO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "meeting-action-items",
    "json_schema": {
      "type": "object",
      "properties": {
        "action_items": { "type": "array", "items": { "type": "string" } }
      },
      "required": ["action_items"]
    }
  }'

List schemas#

GET/v1/schemas

List the tenant's schemas. Supports limit (1 to 100, default 25), cursor, and include_templates (default false). Returns { data, next_cursor }.

bash

curl "https://api.lirovo.ai/v1/schemas?include_templates=true" \
  -H "Authorization: Bearer $LIROVO_API_KEY"

Get a schema#

GET/v1/schemas/{id}

Get one schema by id. Returns 404 if it does not exist for this tenant.

Schema object

idrequired

string

Schema id, e.g. sch_a1b2c3.

namerequired

string

Display name.

json_schemarequired

object

The stored JSON Schema document.

versionrequired

integer

Schema version, starts at 1.

is_templaterequired

boolean

True for built-in templates.

template_category

string | null

One of meeting, sales, interview, lecture, podcast.

created_atrequired

string (date-time)

Creation timestamp.

archived_at

string (date-time) | null

Set when soft-deleted.

bash

curl https://api.lirovo.ai/v1/schemas/sch_a1b2c3 \
  -H "Authorization: Bearer $LIROVO_API_KEY"

Delete a schema#

DELETE/v1/schemas/{id}

Soft-delete a schema. Sets archived_at so referencing jobs and extractions keep their foreign keys; subsequent reads return 404. Idempotent; returns { id, deleted_at }.

bash

curl -X DELETE https://api.lirovo.ai/v1/schemas/sch_a1b2c3 \
  -H "Authorization: Bearer $LIROVO_API_KEY"