For developers

Workspace Integration API

Connect your company's systems to its Krebsiti workspace: create and manage agents, allocate credits, upload knowledge-base files, and keep clients, cases and the calendar in sync over a REST API.

https://krebsiti.com/api/integration/v1Version v1Download OpenAPI
Contents

Overview

The API drives the workspace by the same rules as the web app: the same permissions, billing and history. A key acts as the member who created it, limited to the scopes it was given. Requests and answers are JSON; files are uploaded as multipart/form-data.

What you can do

  • Create, edit, suspend and remove agents, and reset their passwords
  • Read the company's balance and usage, allocate credits and set limits
  • Manage knowledge-base collections and upload files
  • Keep clients, cases and case files in sync
  • Manage calendar events
  • Read roles, and manage groups and their members

Quickstart

  1. 1. Create a key

    In your workspace, open Company → Integration and create a key with the scopes you need. Copy it: the full key is shown once. Keep it on your server, for example in the environment variable KREBSITI_API_KEY. When you create a key (and later with Edit) you can set an expiry (from 1 hour to 2 years, or never), the IP addresses and domains it accepts requests from, and its request limit. A key with the agents:write or credits:write scope can create staff accounts and move credits: treat it like that member's own login.

  2. 2. Check the balance

    Your first request: the company's credit balance. The key needs the workspace:read scope.

    curl "https://krebsiti.com/api/integration/v1/balance" \
  -H "Authorization: Bearer $KREBSITI_API_KEY"

  3. 3. Create an agent

    Send POST /agents with the agent's first name, last name and email prefix (agents:write). The answer carries the agent and a temporary password, once. See Create an agent

Loading the API reference…