Quickstart

This walks through the whole content model end to end: create a language, an author, a category, and finally an article — then read it back. It assumes you already have an API key.

New here? Start with Authentication and API keys. The SDKs do all of this for you in any supported language.

Before you start

Set two variables. Everything below uses them.

export CMS_BASE="https://api.octaviatech.app/cms"
export CMS_KEY="your-api-key"

A tiny helper makes the rest readable:

cms() {
  curl -s -X "$CMS_BASE$1" \
    -H "x-api-key: $CMS_KEY" \
    -H "Content-Type: application/json" \
    ${2:+-d "$2"}
}

1. Create a language

Articles can only be written in a language that already exists.

cms /languages/create '{"code":"en","name":"English"}'

{ "success": true, "statusCode": 201, "message": "Language created successfully", "data": { "code": "en", "name": "English" } }

2. Create an author

cms /authors/create '{"name":"Nima Janbaz","slug":"nima-janbaz","email":"nima@octaviatech.app"}'

Keep the returned _id — the article needs it.

3. Create a category

cms /categories/create '{"name":"Engineering","slug":"engineering"}'

Keep this _id too. A subcategory cannot be created without it.

4. Create a subcategory

cms /subcategories/create '{"name":"TypeScript","slug":"typescript","categoryId":"<category-id>"}'

Optional. Skip it if you file articles under categories only.

5. Create an article

cms /articles/create '{
  "mainTitle": "Shipping the AI CMS SDK",
  "content": "Full article body...",
  "category": ["<category-id>"],
  "subCategory": ["<subcategory-id>"],
  "author": "<author-id>",
  "language": "en",
  "tags": ["typescript", "sdk"]
}'

category and subCategory are arrays of IDs. A single string is rejected.

6. Read it back

cms '/articles/getAll?page=1&limit=10'

{
  "success": true,
  "statusCode": 200,
  "message": "Request successful",
  "data": { "articles": [ { "_id": "…", "mainTitle": "Shipping the AI CMS SDK" } ] },
  "pagination": { "total": 1, "page": 1, "limit": 10, "totalPages": 1 }
}

Adding a form

Forms are a separate tree and can be built at any time. Create one, then submit to it:

cms /forms/create '{
  "title": { "en": "Contact us" },
  "slug": "contact-us",
  "sections": [
    {
      "title": { "en": "Your details" },
      "fields": [
        { "name": "email", "type": "email", "label": { "en": "Email" }, "required": true }
      ]
    }
  ]
}'

cms '/forms/<form-id>/submit' '{"language":"en","values":{"email":"nima@octaviatech.app"}}'

Forms

The full form model, field types, and submissions

Using an SDK instead

The same sequence, in JavaScript, with no HTTP plumbing:

import { CMS } from "@octavia/cms-sdk";

const cms = CMS.init(process.env.OCTAVIA_API_KEY!);

await cms.language.create({ code: "en", name: "English" });
const author = await cms.author.create({
  name: "Nima Janbaz",
  slug: "nima-janbaz",
  email: "nima@octaviatech.app",
});
const category = await cms.category.create({ name: "Engineering", slug: "engineering" });

await cms.article.create({
  mainTitle: "Shipping the AI CMS SDK",
  content: "Full article body...",
  category: [category.data._id],
  author: author.data._id,
  language: "en",
});

JavaScript

Node.js and browser.

Python

Python 3.9+.

PHP

PHP 8.0+.

C#

.NET 6+.

Go

Go 1.21+.

Common first errors

Code	What it means
401	The `x-api-key` header is missing or the key is invalid. Check Authentication.
403	The key is valid but its role cannot do this. See API keys.
422	A required field is missing, or a value failed the field’s validation.
423	The workspace is inactive — usually an expired plan. Check the dashboard.
429	Over 50 requests per second. Back off and retry.

Every response is wrapped in the same envelope, so you can branch on statusCode or success without parsing the body. See Response format.

Get started

Languages

SDKs

Content Management

Forms

AI Automation

Social Publishing

Analytics

AI

AI Conversation

Articles

Authors

Categories

Forms

Form Submissions

Languages

Reports

Subcategories

Tags

Before you start

Adding a form

Forms

Using an SDK instead

JavaScript

Python

PHP

C#

Go

Common first errors

​Before you start

​Adding a form

Forms

​Using an SDK instead

JavaScript

Python

PHP

C#

Go

​Common first errors

Before you start

Adding a form

Using an SDK instead

Common first errors