Karybase API

The Karybase API exposes selected organization and inventory data for external integrations.

Choose the interface you want to use:

Call Karybase directly with HTTPS requests, headers, query parameters, and JSON responses.

HTTP API

Base URL, authentication headers, general endpoints, and module status.

Inventory HTTP

Raw inventory item endpoints for list and detail requests.

Planned HTTP Modules

Services, Projects, CRM, Retail, and Reservations use the same feature flag IDs when public endpoints are added.

Use @karybase/sdk for typed JavaScript methods instead of managing URLs directly.

JavaScript SDK

Installation, client setup, module metadata, and feature flag mapping.

Inventory SDK

Use karybase.inventory.list(params) and karybase.inventory.get(params).

Planned SDK Models

Services, Projects, CRM, Retail, and Reservations expose model metadata while endpoints are planned.

API Origin

Public HTTP requests use the Karybase API origin:

https://api.karybase.com

The docs site runs on https://docs.karybase.com; API requests go to https://api.karybase.com.

Current HTTP Surface

Area	Endpoint	Authentication
Health	`GET /api/v1/health`	No API key
API key verification	`GET /api/v1/auth/verify`	API key
Organization summary	`GET /api/v1/organization`	API key
Inventory item list	`GET /api/v1/inventory/items`	API key with inventory view access
Inventory item detail	`GET /api/v1/inventory/item`	API key with inventory view access

Request Format

Send API keys using either header:

x-api-key: kb_live_...

Authorization: Bearer kb_live_...

JSON responses use Content-Type: application/json. Browser clients may call the public API because the HTTP handlers allow authorization, content-type, and x-api-key headers.

Key Types

Karybase supports organization API keys and user API keys.

API keys are scoped to their organization. Organization-scoped endpoints resolve the organization from the key, so new clients do not need an organizationId query parameter.

Example

curl "https://api.karybase.com/api/v1/inventory/items?limit=25" \
  -H "Authorization: Bearer $KARYBASE_API_KEY"

const items = await karybase.inventory.list({ limit: 25 });

Status Codes

Status	Meaning
`200`	Request succeeded
`400`	Required query parameter is missing or malformed
`401`	API key is missing, invalid, disabled, expired, exhausted, or rate limited
`403`	API key is valid but cannot access the requested organization
`404`	Requested organization or inventory item was not found