Skip to main content
Lydie

Developer Docs

External API Reference

OpenAPI: 3.1.0

Version: v1

Schema endpoint: /api/v1/openapi.json

Authentication

All endpoints require a bearer API key in the Authorization header. 

curl -X GET \
  https://api.lydie.co/api/v1/collections/blog/documents?limit=10 \
  -H 'Authorization: Bearer <API_KEY>'

Endpoints

post /api/v1/collections

Create collection

Creates a collection with optional initial properties.

patch /api/v1/collections/{collectionId}

Update collection API settings

Updates lookup key and indexed fields used by external API querying.

post /api/v1/collections/{collectionId}/documents

Create collection document

Creates a document in a collection with optional parent and field values.

delete /api/v1/collections/{collectionId}/documents/{docId}

Delete collection document

Soft-deletes a document from a collection.

get /api/v1/collections/{collectionId}/documents/{docId}/children

List document children

Returns children for a document with optional recursive depth.

get /api/v1/collections/{collectionId}/documents/{docId}/related

List related documents

Returns related documents for a collection document.

get /api/v1/collections/{collectionId}/documents/{value}

Get one collection document

Fetches a document by id (default) or by the configured lookup key via ?by=field.

post /api/v1/collections/{collectionId}/properties

Create collection properties

Appends one or more properties to an existing collection.

get /api/v1/openapi.json

OpenAPI schema

Returns the OpenAPI 3.1 document for this external API.