API documentation

Beta

What you can do with the Sice API today. The full reference, with every field and example, is sent on request while we publish it.

Resources

Authentication

API keys you create in Workspace › Connections › API keys and send in the Authorization: Bearer sk_… header. Each key belongs to the workspace you create it in and reaches only its data.

Permissions per key

Each key carries only the permissions you give it, by resource and action: create contacts but not read tickets, for example. Every endpoint states the permission it needs.

CRM

Create and update contacts, send and read each contact's messages, and open and read tickets.

Documents

Read the categories and documents in Resources, with their content. The key reads every document in the workspace, regardless of who may see it inside Sice: give this permission only to systems you trust.

AI agents

With Automations: list your agents, talk to one from your application and fetch the conversation's history.

Websites

Your own server records what only it knows (a payment, a completed sign-up) into the same events the site measures, and you read the analytics summary and the visits the app shows.

Limits and errors

By default, 60 requests per minute, 1,000 per hour and 10,000 per day per key; past that it answers 429 with Retry-After. 401 is a missing or invalid key; 403, a permission the key lacks, an IP outside its list or a module that is off (agents need Automations on).

Webhooks

When your team answers a contact from the CRM, Sice sends that message to the URL you set on the key.

Endpoints

POST/api/crm/contactsPermission: crm:contacts:createCreate a contact

PATCH/api/crm/contacts/:idPermission: crm:contacts:updateUpdate a contact

POST/api/crm/contacts/:id/messagesPermission: crm:messages:sendSend a message

GET/api/crm/contacts/:id/messagesPermission: crm:messages:readRead messages

GET/api/crm/ticketsPermission: crm:tickets:listList tickets

GET/api/crm/tickets/:idPermission: crm:tickets:readRead a ticket

POST/api/crm/ticketsPermission: crm:tickets:createCreate a ticket

GET/api/resources/categoriesPermission: resources:categories:listList categories

GET/api/resources/documentsPermission: resources:documents:listList documents

GET/api/resources/documents/:idPermission: resources:documents:readRead a document

GET/api/automations/agentsPermission: automations:agents:readList agents

GET/api/automations/agents/:idPermission: automations:agents:readRead an agent

POST/api/automations/chatPermission: automations:chat:sendTalk to an agent

GET/api/automations/chat/historyPermission: automations:chat:readRead the conversation's history

POST/api/websites/eventsPermission: websites:events:createRecord a site's events

GET/api/websites/analyticsPermission: websites:analytics:readRead the analytics

GET/api/websites/sessionsPermission: websites:sessions:listList the visits

Integrating your system with Sice? Write to us and we will send you the full reference.

Request API access