> For the complete documentation index, see [llms.txt](https://docs.kinesis.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kinesis.network/api.md).

# 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

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Make your first request</strong></td><td>Check your identity, create a project and launch a container.</td><td><a href="/api/quickstart.md">API quickstart</a></td></tr><tr><td><strong>Authentication and scopes</strong></td><td>Choose permissions and understand shared-resource access.</td><td><a href="/api/authentication.md">Authentication and scopes</a></td></tr><tr><td><strong>Reliable integrations</strong></td><td>Pagination, rate limits, asynchronous work and safe retries.</td><td><a href="/api/conventions.md">Request conventions</a></td></tr></tbody></table>

## API reference

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

| Resource                           | Operations                                                                                              |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------- |
| [Docs](/api/docs.md)               | Built-in guides                                                                                         |
| [Account](/api/account.md)         | Identity, credential context and notifications                                                          |
| [Projects](/api/projects.md)       | List, create, inspect, rename and delete                                                                |
| [Apps](/api/apps.md)               | Create, configure, check placement, move, operate, retain/export/clear logs and inspect usage           |
| [Sharing](/api/sharing.md)         | Grantees, invitations and leaving shared projects, apps or grids                                        |
| [Builds](/api/builds.md)           | Build history, status, logs and rebuilds                                                                |
| [Domains](/api/domains.md)         | Reserve, verify, attach, detach and choose a default                                                    |
| [GitHub](/api/github.md)           | Accounts, repositories, branches, commits, contents and Dockerfiles                                     |
| [Templates](/api/templates.md)     | App Gallery configurations                                                                              |
| [Grids](/api/grids.md)             | Compose capacity, set server priority and start/stop grid apps                                          |
| [Servers](/api/servers.md)         | Provision, inspect, read machine logs, power, replace, attach BYOD, manage Smart Lifecycle and SSH keys |
| [Catalog](/api/catalog.md)         | Regions, zones and instance types                                                                       |
| [Marketplace](/api/marketplace.md) | Browse spot capacity                                                                                    |
| [Billing](/api/billing.md)         | Balance, costs, invoices/PDFs, ledger, saved cards, vouchers, node protection, auto-reload and payments |

[App configuration guide](/api/app-configuration.md) · [Response models](/api/models.md) · [Errors and recovery](/api/errors.md) · [Download OpenAPI](https://4256139742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fobv1L4EfK71xeiC2NpU7%2Fuploads%2Fq3IkP1awx0kPSmh3Mx4v%2Fkinesis-public-openapi.json?alt=media)

For Kinesis compute, use `kinesis` in provider selectors such as `csp`. Discover supported regions and machine types through the [Catalog](/api/catalog.md).

## 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](/mcp.md) exposes task-oriented tools over the same services. OAuth tokens from an MCP connection are valid for MCP only; use an API key for REST.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kinesis.network/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.