v0.9.0

Octively Developer Docs

Everything you need to add a client chatbot portal to your project — from embed script to API calls.

Getting started

Four steps from zero to a fully working client portal:

Create an account

Create your first bot

Go to Dashboard → Bots → New bot. Give it a name and choose an AI model. Save to get your embed key.

Add the embed script

Copy the <script> tag from the bot settings page and paste it before the </body> tag on your client's site.

Invite the client

Go to Clients → Invite. Enter your client's email. They get a link to set a password and access their portal.

Embed guide

Add the following script to any HTML page. Replace bot_XXXXwith your bot's embed key from the Dashboard.

<script
  src="https://app.octively.com/embed.js"
  data-bot-key="bot_XXXXXXXXXXXX"
  defer
></script>

The widget initialises asynchronously and does not block page load. It adds a floating chat button to the bottom-right corner of your page.

API reference

All API endpoints require a Bearer token from your workspace settings. Base URL: https://Octively.com/api/v1

Method	Path	Description
GET	/api/v1/bots	List all bots in your workspace
GET	/api/v1/bots/:id	Get a single bot by ID
GET	/api/v1/bots/:id/conversations	List conversations for a bot
GET	/api/v1/bots/:id/leads	List captured leads for a bot
POST	/api/v1/bots/:id/message	Send a message via a bot (server-side)
GET	/api/v1/usage	Get credit usage for the current billing period

Supported AI models

Choose the model that best fits each bot — from fast and budget-friendly to frontier-class. Select per bot from the bot settings page.

OpenAI

GPT-4o

OpenAI

GPT-4o Mini

Anthropic

Claude 3.5 Sonnet

Anthropic

Claude 3 Haiku

Google

Gemini 2.0 Flash

Mistral

Mistral Large

More models available. All inference is routed through a unified gateway — switch models without changing your embed code.

FAQ

Does the embed widget work on WordPress?

Yes. Paste the script tag in your theme's footer.php or use a custom HTML widget. A dedicated WordPress plugin is on the roadmap.

Can I customise the widget appearance?

Yes. Bot settings let you change the accent colour, widget position, greeting message, and (on Agency+ plans) upload a custom logo.

How are credits consumed?

Each AI response costs credits proportional to the length of the conversation. Credits are deducted before each call. Your monthly plan includes a credit allowance; additional packs are available on the Billing page.

Ready to build?

Get your embed key — free plan, no card required.

Start free