SDKs

Official client libraries are available for five languages. Every SDK wraps the same REST endpoints, sends your API key automatically, and returns the same envelope shape as the raw API.

New — the JavaScript SDK is the most complete and the one we build against first. Start there if you are unsure which to pick.

JavaScript

Node.js 18+ and modern browsers. ESM and TypeScript types included.

Python

Python 3.9+. No third-party dependencies.

PHP

PHP 8.0+. PSR-18 compatible, Composer package.

C#

.NET 6+. Inject your own HttpClient for full control.

Go

Go 1.21+. Single module, zero dependencies.

Install

JavaScript
Python
PHP
C#
Go

npm install @octavia/cms-sdk

pip install octavia-cms-sdk

composer require octavia/cms-sdk

dotnet add package Octavia.CmsSdk

go get github.com/octaviatech/cms-sdk-go

Quick start

Every SDK is initialized with your API key. The base URL defaults to the production endpoint, so the only required value is the key.

JavaScript
Python
PHP
C#
Go

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

const cms = CMS.init("sk_live_...");

const res = await cms.article.getAll({ page: 1, limit: 10 });
if (res.ok) {
  console.log(res.data);
} else {
  console.error(res.error);
}

from octavia_cms_sdk import CMS

cms = CMS.init("sk_live_...")

res = cms.article.get_all({"page": 1, "limit": 10})
if res.ok:
    print(res.data)
else:
    print(res.error)

use Octavia\Cms\CMS;

$cms = CMS::init("sk_live_...");

$res = $cms->article->getAll(['page' => 1, 'limit' => 10]);
if ($res->ok) {
    print_r($res->data);
} else {
    print_r($res->error);
}

using Octavia.Cms;

var cms = CMS.Init("sk_live_...");

var res = await cms.Article.GetAllAsync(new Dictionary<string, object>
{
    ["page"] = 1,
    ["limit"] = 10,
});
if (res.Ok) Console.WriteLine(res.Data);
else Console.Error.WriteLine(res.Error?.Message);

package main

import (
    "fmt"

    "github.com/octaviatech/cms-sdk-go/sdk"
)

func main() {
    cms, err := sdk.InitCMS("sk_live_...", nil)
    if err != nil {
        panic(err)
    }

    res, err := cms.Article.GetAll(map[string]interface{}{"page": 1, "limit": 10})
    if err != nil {
        panic(err)
    }
    fmt.Println(res.Data)
}

Authentication

The only thing you need to configure is your API key. It is sent on every request as the x-api-key header, and the SDKs do not expose any other header configuration — there is nothing else for a caller to set.

Multi-tenancy headers are injected by the API gateway on your behalf. You never pass them, and no SDK option accepts them.

Keep the key out of source control. Read it from the environment in every language:

JavaScript
Python
PHP
C#
Go

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

import os

cms = CMS.init(os.environ["OCTAVIA_API_KEY"])

$cms = CMS::init(getenv('OCTAVIA_API_KEY'));

var cms = CMS.Init(Environment.GetEnvironmentVariable("OCTAVIA_API_KEY")!);

key := os.Getenv("OCTAVIA_API_KEY")
cms, err := sdk.InitCMS(key, nil)

Response shape

Every endpoint returns the same envelope, and every SDK unwraps it into one consistent result object. See Response format for the raw structure.

Field	Type	Meaning
`ok`	boolean	`true` when the HTTP status was 2xx
`data`	object	The `data` field of the envelope, or `null`
`error`	object \| null	The API error, or `null` on success
`meta`	object \| null	Pagination and count metadata, when the endpoint returns it

By default an API error is a normal return value, not an exception. Set throw_on_error to raise instead:

JavaScript
Python
PHP
C#
Go

const cms = CMS.init(process.env.OCTAVIA_API_KEY!, { throwOnError: true });

cms = CMS.init(key, throw_on_error=True)

$cms = CMS::init($key, ['throwOnError' => true]);

var cms = CMS.Init(key, new CMSOptions { ThrowOnError = true });

cms, err := sdk.InitCMS(key, &sdk.CMSOptions{ThrowOnError: true})

The Go SDK’s ThrowOnError panics rather than returning an error, and the panic value is a plain string — recover with defer/recover if you enable it.

Resources

The names below are the same across all five SDKs. Method names differ only in capitalisation convention.

Resource	Access	Covers
`article`	`.article`	Articles: CRUD, search, publish state, SEO analysis
`author`	`.author`	Author profiles
`category`	`.category`	Categories
`subcategory`	`.subcategory`	Subcategories
`form`	`.form`	Forms, captcha config
`formSubmission`	`.formSubmission`	Form submissions
`language`	`.language`	Languages
`tag`	`.tag`	Tags
`report`	`.report`	Statistics, dashboards, charts
`ai`	`.ai`	Summarize, translate, SEO, repurpose, social publish
`aiConversation`	`.aiConversation`	Chat sessions and messages
`raw`	`.raw`	The underlying HTTP client, for unlisted endpoints

The JS and Go SDKs are generated from the OpenAPI spec and cover the full surface, including AI conversation, meta and tags. The Python, PHP and C# SDKs expose the resources above; for anything outside them, call through raw.

Configuration

JavaScript
Python
PHP
C#
Go

const cms = CMS.init(key, {
  baseUrl: "https://api.octaviatech.app/cms", // default
  timeoutMs: 30_000,                          // default
  throwOnError: false,                        // default
});

cms = CMS.init(key, timeout_ms=30_000, throw_on_error=False)

$cms = CMS::init($key, ['timeoutMs' => 0, 'throwOnError' => false]);

var cms = CMS.Init(key, new CMSOptions
{
    BaseUrl = "https://api.octaviatech.app/cms",
    Timeout = TimeSpan.FromSeconds(30),
    ThrowOnError = false,
});

client, err := sdk.NewClient(sdk.ClientConfig{
    BaseURL: sdk.CMSBaseURL,
    ApiKey:  key,
    Timeout: 30 * time.Second,
})

In the PHP SDK timeoutMs defaults to 0, which means no timeout. Set it explicitly in production.

Retry and rate limits

None of the SDKs retry automatically. A 429 is returned as a normal error result, so you can inspect retry-after and back off yourself:

JavaScript
Python

const res = await cms.article.getAll();
if (!res.ok && res.error?.status === 429) {
  const wait = Number(res.error.headers?.["retry-after"] ?? 1);
  await new Promise((r) => setTimeout(r, wait * 1000));
}

import time

res = cms.article.get_all()
if not res.ok and res.error and res.error.status == 429:
    time.sleep(1)

429 details are only available where the SDK exposes response headers — the JavaScript SDK’s error.headers. Elsewhere, use a fixed backoff.

Support

Need something not covered here? Open a ticket with the operation you called, your SDK version, and the request ID from the response headers.

Dashboard

Manage API keys and inspect usage.

Support

Reach the engineering team.

Get started

Languages

Content Management

Forms

AI Automation

Social Publishing

Analytics

AI

AI Conversation

Articles

Authors

Categories

Forms

Form Submissions

Languages

Reports

Subcategories

Tags

SDKs

JavaScript

Python

PHP

C#

Go

Install

Quick start

Authentication

Response shape

Resources

Configuration

Retry and rate limits

Support

Dashboard

Support

JavaScript

Python

PHP

C#

Go

​Install

​Quick start

​Authentication

​Response shape

​Resources

​Configuration

​Retry and rate limits

​Support

Dashboard

Support

Install

Quick start

Authentication

Response shape

Resources

Configuration

Retry and rate limits

Support