Core Endpoints
Learn the basics of Lumino — its structure, features, and how it can help you create clear, organized documentation.
Articles API
Manage individual documentation pages. These endpoints handle content retrieval, creation, and updates.
Get
/v1/articles
List Articles
Parameters
Name
Type
Description
collection_id
string
Filter articles by a specific collection slug.
limit
integer
Number of results to return (Default: 20).
Parameters
Jason
Coppied
1{
2 "data": [
3 {
4 "id": "art_9283",
5 "title": "Introduction to API",
6 "slug": "intro-api",
7 "status": "published"
8 }
9 ],
10 "total": 124
11}
Post
/v1/articles
Create Article
Body Payload
Jason
Coppied
1{
2
3 "title": "New Article",
4 "content": "# Markdown Content Here",
5 "collection_id": "guides"
6
7}Collections API
Manage the hierarchy of your documentation by interacting with collections.
Get
/v1/collections
List Collections
Jason
Coppied
1{
2 "collections": [
3 {
4 "id": "col_1",
5 "name": "Getting Started",
6 "order": 1
7 },
8 {
9 "id": "col_2",
10 "name": "API Reference",
11 "order": 2
12}
13 ]
14
15}Search API
Manage the hierarchy of your documentation by interacting with collections.
Get
/v1/collections
Global Search
Returns a ranked list of articles matching the search term across title and content.
Query:?q=authentication
Rate Limiting
The Lumino API is limited to100 requests per minuteper API key. If you exceed this, you will receive a 429 status code.
