Quickstart

This quickstart walks you through creating an account, activating a service, and generating an API key. By the end, you will have a live workspace, an active service on a plan, and the credentials to start building.

Prerequisites: You’ll need an Octavia account. If you don’t have one yet, create a free account — no credit card required.

Go to octaviatech.app and click Login.

If you already have an account, sign in. Otherwise click Create account and enter First name, Last name, Email, Password and Region, then complete registration.

Select your team

After sign-in you’ll land in the Dashboard. Your first team is created automatically from your name — select the default team to continue. You can create more teams later.

Open the Octavia Services catalog

From the dashboard, open Octavia Services and pick the product you want — AI CMS, Storage, Auth, Payments, and others.

Choose the service you want to activate.

Choose a plan

Pick the plan that matches your team’s needs. You can start on the Free plan and upgrade at any time. Every plan is the same API — the difference is what you are allowed to do before the API returns 426.

During setup you can claim a free hosted subdomain in this format:

https://<your-domain>.octaviatech.app

Configure your service

Once provisioning completes (and billing finishes, if you chose a paid plan) you can view service settings, open the product console, create API keys, and manage everything from the left navigation.

Create your first API key

Go to Settings → API Keys, create a key, and give it three things:

Scope

Set the scope to the service you just activated. A key is scoped to a team and a service, so a key for another Octavia product never counts against this one’s allowance.

Role

Start at the lowest role that covers your use case. Read-only is enough for a public site or a cache; raise it only when a call actually fails with 403.

Expiration

Either a specific end date, or a lifetime with no expiry. Copy the key when it is created — it is shown only once.

A key in client-side code — a browser bundle, a mobile app, a public repository — is a compromised key. Read it from the environment and call Octavia from your server only.

API keys

Create, edit, disable and revoke keys, with the full role table.

Teams & API keys

Which role to pick for which system, and how rotation works.

Make your first call

Every endpoint needs one header: x-api-key.

curl -i https://api.octaviatech.app/cms/articles/getAll?limit=1 \
  -H "x-api-key: YOUR_API_KEY"

{
  "success": true,
  "statusCode": 200,
  "message": "Request successful",
  "data": { "articles": [] },
  "pagination": { "total": 0, "page": 1, "limit": 1, "totalPages": 0 }
}

That is the whole authentication model. There is no second header to set.

Calling api.octaviatech.app/articles/getAll without the /cms segment returns a 404. See Base URL.

Use an SDK instead

Every SDK sends the key for you and unwraps the envelope.

JavaScript
Python
PHP
C#
Go

import { CMS } from "@octaviatech/cms";

const cms = CMS.init(process.env.OCTAVIA_API_KEY!);
const res = await cms.article.getAll({ query: { limit: 1 } });

import os
from octavia_cms_sdk import CMS

cms = CMS.init(os.environ["OCTAVIA_API_KEY"])
res = cms.article.getAll(query={"limit": 1})

use Octavia\CmsSDK\CMS;

$cms = CMS::init(getenv('OCTAVIA_API_KEY'), ['timeoutMs' => 30_000]);
$res = $cms->article->getAll(['limit' => 1]);

var cms = CMS.Init(Environment.GetEnvironmentVariable("OCTAVIA_API_KEY")!);
var res = await cms.Article.GetAllAsync(new Dictionary<string, string?>
{
    ["limit"] = "1",
});

cms, err := sdk.InitCMS(os.Getenv("OCTAVIA_API_KEY"), nil)
if err != nil {
    log.Fatal(err)
}
res := cms.Article.GetAll(map[string]any{"limit": 1})

All SDKs

Compare all five and pick one.

What next

AI CMS quickstart

Build the whole content model in about five minutes.

Build with Octavia

Which service to pick, and what to get right before you ship.

Troubleshooting

I can't see my default team

Refresh the dashboard or reopen the team switcher. If the default team was renamed or removed, create a new one and select it before continuing.

The service isn't visible after I picked a plan

Check your billing status if you chose a paid plan. If payment succeeded, refresh the dashboard — provisioning usually completes within seconds. A workspace that is still inactive answers API calls with 423.

Requests fail with 401

The x-api-key header must be present on every request, and the key must be active and unexpired. A key that is disabled returns 401 just like a missing one.

Requests fail with 403

The key is valid but its role does not allow that operation. Authentication and authorization are separate checks — use a key with a higher role.

I hit 429

You were throttled. Back off exponentially with jitter rather than retrying immediately, and prefer the server’s retry-after where your SDK surfaces response headers.

I hit 426

That is a plan quota, not a throttle — retrying cannot fix it. Check your usage in the dashboard, upgrade the plan, or reduce what you are creating.

Get started

Core concepts

Build with Octavia

Resources

Create your first API key

API keys

Teams & API keys

Make your first call

Use an SDK instead

All SDKs

What next

AI CMS quickstart

Build with Octavia

Troubleshooting

​Create your first API key

API keys

Teams & API keys

​Make your first call

​Use an SDK instead

All SDKs

​What next

AI CMS quickstart

Build with Octavia

​Troubleshooting

Create your first API key

Make your first call

Use an SDK instead

What next

Troubleshooting