Developer API - Relixir

The Relixir Developer API allows you to programmatically access and manage your CMS content. Use it to integrate Relixir with your existing workflows, build custom integrations, or automate content management.

Base URL

https://api.relixir.ai

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer rlx_live_your_api_key_here

Creating an API Key

Go to Settings → Developer API in your Relixir dashboard
Click Create API key
Give your key a descriptive name (e.g., “Production API Key”)
Copy the key immediately - it will only be shown once

Keep your API keys secure. Never expose them in client-side code or commit them to version control.

Interactive Documentation

Full interactive API documentation with request/response examples is available at:

API Reference

Explore the full API with Swagger UI

Endpoints

Collections

List Collections

Returns all internal (Relixir-owned) CMS collections for your organization.Request

GET /v1/collections

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	100	Maximum number of collections (1-500)
`offset`	integer	0	Number of collections to skip

Example

curl -X GET "https://api.relixir.ai/v1/collections" \
  -H "Authorization: Bearer rlx_live_your_api_key"

import requests

response = requests.get(
    "https://api.relixir.ai/v1/collections",
    headers={"Authorization": "Bearer rlx_live_your_api_key"}
)
collections = response.json()

const response = await fetch("https://api.relixir.ai/v1/collections", {
  headers: { Authorization: "Bearer rlx_live_your_api_key" }
});
const collections = await response.json();

Response

{
  "collections": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "name": "Blog Posts",
      "slug": "blog",
      "settings": {}
    }
  ],
  "total": 1
}

Get Collection

Get details of a specific collection by ID.Request

GET /v1/collections/{collection_id}

Example

curl -X GET "https://api.relixir.ai/v1/collections/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer rlx_live_your_api_key"

Content Items

List Items

Returns content items with optional filters.Request

GET /v1/items

Query Parameters

Parameter	Type	Description
`collection_id`	UUID	Filter by collection
`status`	string	Filter by status: `draft`, `published`, `archived`
`limit`	integer	Maximum items to return (1-500, default: 100)
`offset`	integer	Number of items to skip

Example

curl -X GET "https://api.relixir.ai/v1/items?collection_id=550e8400-e29b-41d4-a716-446655440000&status=published" \
  -H "Authorization: Bearer rlx_live_your_api_key"

Response

{
  "items": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "collection_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "published",
      "slug": "hello-world",
      "title": "Hello World",
      "body": "<p>Welcome to my blog!</p>",
      "meta_description": "An introduction post",
      "thumbnail_url": null,
      "current_revision_id": null
    }
  ],
  "total": 1,
  "limit": 100,
  "offset": 0
}

Get Item

Get a specific content item by ID.Request

GET /v1/items/{item_id}

Example

curl -X GET "https://api.relixir.ai/v1/items/660e8400-e29b-41d4-a716-446655440001" \
  -H "Authorization: Bearer rlx_live_your_api_key"

Response

{
  "id": "660e8400-e29b-41d4-a716-446655440001",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "collection_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "published",
  "slug": "hello-world",
  "title": "Hello World",
  "body": "<p>Welcome to my blog!</p>",
  "meta_description": "An introduction post",
  "thumbnail_url": null,
  "current_revision_id": "770e8400-e29b-41d4-a716-446655440003"
}

Get Item by Slug

Get a content item by its slug. This is useful when you know the URL slug but not the item ID. Searches across all collections by default, or within a specific collection if collection_id is provided.Request

GET /v1/items/by-slug/{slug}

Path Parameters

Parameter	Type	Description
`slug`	string	The URL slug of the item

Query Parameters

Parameter	Type	Description
`collection_id`	UUID	Optional. Filter to a specific collection

Example

curl -X GET "https://api.relixir.ai/v1/items/by-slug/hello-world" \
  -H "Authorization: Bearer rlx_live_your_api_key"

import requests

response = requests.get(
    "https://api.relixir.ai/v1/items/by-slug/hello-world",
    headers={"Authorization": "Bearer rlx_live_your_api_key"}
)
item = response.json()

const response = await fetch(
  "https://api.relixir.ai/v1/items/by-slug/hello-world",
  { headers: { Authorization: "Bearer rlx_live_your_api_key" } }
);
const item = await response.json();

Response

{
  "id": "660e8400-e29b-41d4-a716-446655440001",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "collection_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "published",
  "slug": "hello-world",
  "title": "Hello World",
  "body": "<p>Welcome to my blog!</p>",
  "meta_description": "An introduction post",
  "thumbnail_url": null,
  "current_revision_id": "770e8400-e29b-41d4-a716-446655440003"
}

Create Item

Create a new content item in a collection.Request

POST /v1/items

Request Body

Field	Type	Required	Description
`collection_id`	UUID	Yes	Collection to add the item to
`slug`	string	Yes	URL slug (must be unique in collection)
`title`	string	No	Item title
`body`	string	No	Main content (HTML or Markdown)
`meta_description`	string	No	SEO meta description
`thumbnail_url`	string	No	Featured image URL
`publish_immediately`	boolean	No	If true, publish after creation

Example

curl -X POST "https://api.relixir.ai/v1/items" \
  -H "Authorization: Bearer rlx_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "550e8400-e29b-41d4-a716-446655440000",
    "slug": "my-new-post",
    "title": "My New Post",
    "body": "<p>This is the content of my post.</p>",
    "meta_description": "A great new post about...",
    "publish_immediately": true
  }'

import requests

response = requests.post(
    "https://api.relixir.ai/v1/items",
    headers={
        "Authorization": "Bearer rlx_live_your_api_key",
        "Content-Type": "application/json"
    },
    json={
        "collection_id": "550e8400-e29b-41d4-a716-446655440000",
        "slug": "my-new-post",
        "title": "My New Post",
        "body": "<p>This is the content of my post.</p>",
        "publish_immediately": True
    }
)
item = response.json()

const response = await fetch("https://api.relixir.ai/v1/items", {
  method: "POST",
  headers: {
    Authorization: "Bearer rlx_live_your_api_key",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    collection_id: "550e8400-e29b-41d4-a716-446655440000",
    slug: "my-new-post",
    title: "My New Post",
    body: "<p>This is the content of my post.</p>",
    publish_immediately: true
  })
});
const item = await response.json();

Response (201 Created)

{
  "id": "770e8400-e29b-41d4-a716-446655440002",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "collection_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "published",
  "slug": "my-new-post",
  "title": "My New Post",
  "body": "<p>This is the content of my post.</p>",
  "meta_description": "A great new post about...",
  "thumbnail_url": null,
  "current_revision_id": "880e8400-e29b-41d4-a716-446655440003"
}

Update Item

Update an existing content item.Request

PATCH /v1/items/{item_id}

Request BodyAll fields are optional. Only include fields you want to update.

Field	Type	Description
`slug`	string	URL slug
`title`	string	Item title
`body`	string	Main content
`meta_description`	string	SEO description
`thumbnail_url`	string	Featured image URL

Example

curl -X PATCH "https://api.relixir.ai/v1/items/770e8400-e29b-41d4-a716-446655440002" \
  -H "Authorization: Bearer rlx_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Updated Title"}'

Delete Item

Delete a content item and all its revisions.Request

DELETE /v1/items/{item_id}

Example

curl -X DELETE "https://api.relixir.ai/v1/items/770e8400-e29b-41d4-a716-446655440002" \
  -H "Authorization: Bearer rlx_live_your_api_key"

Response: 204 No Content

Publish Item

Publish a content item, creating a new revision.Request

POST /v1/items/{item_id}/publish

Example

curl -X POST "https://api.relixir.ai/v1/items/770e8400-e29b-41d4-a716-446655440002/publish" \
  -H "Authorization: Bearer rlx_live_your_api_key"

Response

{
  "success": true,
  "message": "Content item published successfully",
  "revision_id": "990e8400-e29b-41d4-a716-446655440004",
  "revision_number": 2,
  "published_at": "2024-01-15T12:00:00Z"
}

Error Handling

The API uses standard HTTP status codes:

Status	Description
`200`	Success
`201`	Created
`204`	No Content (successful deletion)
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - API key missing required scope
`404`	Not Found - Resource doesn’t exist
`409`	Conflict - e.g., duplicate slug
`500`	Server Error

Error Response Format

{
  "detail": "Error message describing what went wrong"
}

Rate Limits

1000 requests per minute per API key
100 requests per second burst limit

If you exceed the rate limit, you’ll receive a 429 Too Many Requests response.

API Key Scopes

API keys have the following scopes by default:

Scope	Description
`collections:read`	Read collection information
`items:read`	Read content items
`items:write`	Create, update, delete, and publish items

Currently, all scopes are granted by default when creating an API key. Granular scope management will be available in a future update.

​Base URL

​Authentication

​Creating an API Key

​Interactive Documentation

API Reference

​Endpoints

​Collections

​Content Items

​Error Handling

​Rate Limits

​API Key Scopes

Base URL

Authentication

Creating an API Key

Interactive Documentation

Endpoints

Collections

Content Items

Error Handling

Rate Limits

API Key Scopes