For the complete documentation index, see llms.txt. This page is also available as Markdown.

REST API

Automate deployments, compute and billing with a documented REST interface.

Build scripts, CI pipelines and integrations on the Kinesis API.

Base URL https://api.kinesis.network/v1 Authentication API key in Authorization: Bearer <key> Format JSON; invoice PDF download returns application/pdf · OpenAPI 3.1

Organization context

Credentials act as their person in each organization. Discover them with GET /orgs. Organization-level calls take ?org=<slug>; project, app and grid calls resolve the organization from the resource. Scopes never raise your organization role. See Authentication and scopes.

API reference

The reference covers 118 operations and 68 response models from the public OpenAPI specification. Each operation includes request fields, responses, required scopes and errors.

Resource
Operations

Built-in guides

Identity, credential context and notifications

Organizations, members, invitations, ownership, settings and audit

List, create, inspect, update name/visibility and delete

Create, configure, check placement, move, operate, retain/export/clear logs and inspect usage

Add organization members, manage grants and handle existing resource invitations

Build history, status, logs and rebuilds

Reserve, verify, attach, detach and choose a default

Accounts, repositories, branches, commits, contents and Dockerfiles

App Gallery configurations

Compose capacity, set server priority and start/stop grid apps

Provision, inspect, read machine logs, power, replace, attach BYOD, manage Smart Lifecycle and SSH keys

Regions, zones and instance types

Browse spot capacity

Balance, costs, invoices/PDFs, ledger, saved cards, vouchers, node protection, auto-reload and payments

App configuration guide · Response models · Errors and recovery · Download OpenAPI

For Kinesis compute, use kinesis in provider selectors such as csp. Discover supported regions and machine types through the Catalog.

Choose the right endpoint

Use these public /v1 endpoints for integrations. The portal also has browser-session routes for its own UI; those are separate from the bearer-authenticated public contract.

For agent integrations, MCP exposes task-oriented tools over the same services. Compact mode separates read tools from _write tools. Credit purchases and auto-reload updates remain available through REST and the portal, but are no longer MCP actions. OAuth tokens from an MCP connection are valid for MCP only; use an API key for REST.

Was this helpful?