> 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/quickstart.md).

# API quickstart

Make your first request, create a project and launch a container.

Use the REST API at `https://api.kinesis.network/v1`. You need a Kinesis account and an API key from [Account settings](https://portal.kinesis.network/dashboard/account).

Open the **API keys** section in Account settings, create a key and copy its token when shown. Complete the two-factor setup or verification prompt if requested.

{% stepper %}
{% step %}

## Check your connection

The examples below use a POSIX shell. Set `KINESIS_API_KEY` in your shell or secret manager, then inspect the identity and permissions attached to it:

```bash
curl --fail-with-body https://api.kinesis.network/v1/me \
  -H "Authorization: Bearer $KINESIS_API_KEY"
```

Inspect `apiKey.scopes`, `apiKey.projectIds` and `limitedToOrgs`, then list reachable organizations:

```bash
curl --fail-with-body https://api.kinesis.network/v1/orgs \
  -H "Authorization: Bearer $KINESIS_API_KEY"
```

Choose the returned organization slug and set `KINESIS_ORG` to it. Your role there must be Admin or Developer to create a project.
{% endstep %}

{% step %}

## Create a project

Requires `projects:write`. A key restricted to specific projects cannot create a new project; use an unrestricted key or an existing permitted project.

```bash
curl --fail-with-body "https://api.kinesis.network/v1/projects?org=$KINESIS_ORG" \
  -H "Authorization: Bearer $KINESIS_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: quickstart-project-001' \
  -d '{"name":"API quickstart","visibility":"private"}'
```

Copy the returned `id` into `PROJECT_ID`. Use a new idempotency key for a different project; reuse this key and the same body only when retrying this request.
{% endstep %}

{% step %}

## Launch a container

Requires `apps:write` and `compute:spend`. Creating an app attempts to start it and can consume the organization’s credits. The project identifies the organization; no `org` parameter is needed for this resource call. This example uses serverless capacity: a Developer needs it enabled, or must add an accessible grid under `config.grids.ids`.

```bash
curl --fail-with-body "https://api.kinesis.network/v1/projects/$PROJECT_ID/apps" \
  -H "Authorization: Bearer $KINESIS_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: quickstart-app-001' \
  -d '{
    "name":"hello-kinesis",
    "config":{
      "image":"nginx:stable",
      "ports":[{"port":80,"protocol":"http80_load_balancer"}],
      "instances":{"min":1,"max":1}
    }
  }'
```

Copy the app's `id` into `APP_ID`. Inspect `start.state`: `requested`, `deferred`, `building` or `failed`. A created app is not necessarily ready to serve traffic.
{% endstep %}

{% step %}

## Follow the deployment

Requires `apps:read`. Poll status and use the addresses returned in `endpoints`:

```bash
curl --fail-with-body \
  "https://api.kinesis.network/v1/projects/$PROJECT_ID/apps/$APP_ID/status" \
  -H "Authorization: Bearer $KINESIS_API_KEY"
```

Read `state`, `targetState`, `nodes` and `errors`. An endpoint with a null address is not wired yet. For a repository deployment, poll the returned `buildId` first.
{% endstep %}

{% step %}

## Stop when you are finished

```bash
curl --fail-with-body -X POST \
  "https://api.kinesis.network/v1/projects/$PROJECT_ID/apps/$APP_ID/stop" \
  -H "Authorization: Bearer $KINESIS_API_KEY"
```

Poll status until stopped. App and project deletion require their apps to be stopped first. Dedicated-server billing is managed through the server lifecycle; stopping an app does not by itself prove that a dedicated server is hibernated.
{% endstep %}
{% endstepper %}

Next: [Authentication and scopes](/api/authentication.md), [request conventions](/api/conventions.md), or the [Apps reference](/api/apps.md).


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.