Skip to content

API Reference

The Corebee API is a RESTful API that allows you to programmatically manage conversations, contacts, messages, and more. All requests require authentication via a Supabase JWT token unless noted otherwise.

Authentication

Include your JWT token in the Authorization header:

curl -X GET https://your-app.com/api/inbox/conversations \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

Rate Limits

PlanRequests/minRequests/day
Trial10500
Pro6010,000

Conversations

Manage support conversations in your inbox.

GET
/api/inbox/conversations

List conversations with filters for status, assignee, and channel.

POST
/api/inbox/conversations

Create a new conversation.

PATCH
/api/inbox/conversations/{id}/status

Update conversation status (open, resolved, pending).

PATCH
/api/inbox/conversations/{id}/assign

Assign conversation to an agent or team.

GET
/api/search

Global search across conversations, messages, and contacts.

Messages

Send and receive messages within conversations.

GET
/api/inbox/conversations/{id}/messages

Fetch messages for a conversation with pagination.

POST
/api/inbox/conversations/{id}/messages

Send a message as an agent. For email channels, sends reply via email.

GET
/api/inbox/messages/{id}

Get a single message by ID.

PUT
/api/inbox/messages/{id}

Edit a message.

DELETE
/api/inbox/messages/{id}

Delete a message.

Contacts

Manage customer contact information.

GET
/api/contacts/{id}

Get contact details.

PUT
/api/contacts/{id}

Update contact information.

GET
/api/contacts/{id}/conversations

List all conversations for a contact.

GET
/api/contacts/{id}/notes

List contact notes.

POST
/api/contacts/{id}/notes

Add a note to a contact.

Teams

Manage teams and team members.

GET
/api/teams

List all teams.

POST
/api/teams

Create a new team.

PUT
/api/teams/{id}

Update a team.

DELETE
/api/teams/{id}

Delete a team.

GET
/api/teams/{id}/members

List team members.

POST
/api/teams/{id}/members

Add members to a team.

Labels

Manage labels for organizing conversations.

GET
/api/labels

List all labels.

POST
/api/labels

Create a label.

PUT
/api/labels/{id}

Update a label.

DELETE
/api/labels/{id}

Delete a label.

GET
/api/inbox/conversations/{id}/labels

Get labels for a conversation.

POST
/api/inbox/conversations/{id}/labels

Add a label to a conversation.

Channels

Configure communication channels.

GET
/api/settings/channels

List all channels.

POST
/api/settings/channels

Create a channel (web_widget or email).

POST
/api/email/inbound

Webhook for receiving inbound emails. No auth required.

Knowledge Base

Manage AI knowledge sources for accurate responses.

GET
/api/knowledge/sources

List knowledge sources.

POST
/api/knowledge/sources

Create a knowledge source (URL, file, or manual).

POST
/api/knowledge/search

Search knowledge base with RAG retrieval.

POST
/api/knowledge/upload

Upload files for knowledge base.

GET
/api/knowledge/gaps

View detected knowledge gaps.

AI Features

AI-powered tools for agents and automation.

GET
/api/ai/suggestions?conversationId={id}

Get AI response suggestions (20/agent/day limit).

GET
/api/ai/summarize?conversationId={id}

Get AI conversation summary.

POST
/api/ai/sentiment

Analyze text sentiment.

POST
/api/ai/assistant

Chat with Corebee Assistant.

POST
/api/ai/translate

Translate message content.

GET
/api/ai/topics

List detected conversation topics.

Automation

Workflow automation, SLA policies, and macros.

GET
/api/automation/rules

List automation rules.

POST
/api/automation/rules

Create an automation rule.

GET
/api/sla/policies

List SLA policies.

POST
/api/sla/policies

Create an SLA policy.

GET
/api/macros

List macros.

POST
/api/macros/{id}/execute

Execute a macro on conversations.

Reports

Analytics and performance metrics.

GET
/api/reports/overview

Overview metrics (conversations, response times, resolution rates).

GET
/api/reports/agents

Agent performance metrics.

GET
/api/reports/heatmap

Conversation heatmap by hour/day.

GET
/api/csat/reports

CSAT performance metrics.

POST
/api/export/conversations

Export conversations to CSV/JSON.

Webhooks

Receive real-time events via webhooks.

GET
/api/webhooks

List webhooks.

POST
/api/webhooks

Create a webhook with event subscriptions.

PATCH
/api/webhooks/{id}

Update a webhook.

DELETE
/api/webhooks/{id}

Delete a webhook.

Widget (Public)

Public endpoints for the embedded chat widget. No authentication required.

POST
/api/widget/configs

Get widget configuration by website_token.

GET
/api/widget/messages

List messages for a widget conversation.

POST
/api/widget/messages

Send a message from the widget (triggers AI response).

GET
/api/widget/conversations

Get or resume a widget conversation.

POST
/api/widget/ai-answer

Get an AI answer from the knowledge base.

GET
/api/widget/articles

Search help center articles.

Settings

Organization and account settings.

GET
/api/settings/organization

Get organization details.

PATCH
/api/settings/organization

Update organization.

GET
/api/settings/ai

Get AI configuration.

PUT
/api/settings/ai

Update AI settings.

POST
/api/billing/checkout

Create a checkout session.

POST
/api/billing/portal

Get billing portal URL.

POST
/api/billing/cancel

Cancel subscription.

GET
/api/notifications

List notifications.

GET
/api/canned-responses

List canned responses.

GET
/api/health

System health check (public).