> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amika.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# SDKs overview

> Official client libraries for the Amika API.

Amika ships official SDKs that wrap the hosted API at
[app.amika.dev](https://app.amika.dev). Use them when you want to drive
rigs from a program rather than the shell.

## Available SDKs

> [card] [TypeScript](https://docs.amika.dev/sdks/typescript/quickstart.md)
>
> `@amika/sdk`: rigs, agent sessions, snapshots, services, and secrets.

> [card] [TypeScript source](https://github.com/gofixpoint/amika/tree/main/sdk/typescript)
>
> Read the source on GitHub.

More languages are coming. In the meantime, you can call the HTTP API
directly. See [API reference](https://docs.amika.dev/reference/api-reference.md) for the OpenAPI
spec.

## When to use the SDK vs. the CLI

| Use case | Tool |
| - | - |
| Day-to-day shell work, ad-hoc rig creation | CLI |
| Building automated pipelines, web apps, or background jobs | SDK |
| One-off scripts to drive an agent through a task | Either. See [Programmatic usage](https://docs.amika.dev/guides/programmatic-usage.md) |
| CI: spin up a rig per PR | SDK (or CLI in a job that has `AMIKA_API_KEY` set) |

The Guides in this site show both side by side, so you can pick whichever
matches the surface you're working in.

## What the SDK does not do

* **It does not source credentials for you.** The TypeScript SDK doesn't
  read `AMIKA_API_KEY` from your environment or from disk. You pass
  `apiKey`, `accessToken`, or `tokenSource`.
* **It does not detect your Git repository.** Pass a clone URL as `repoUrl`.
* **It does not open shells.** Use the CLI's `amika rig ssh` when you need
  one. See [SSH and connect](https://docs.amika.dev/guides/ssh-and-connect.md).
* **It does not list your hosts.** Get a host's ID for `hostId` from
  `amika host get <hostname>`.

The SDK can stream agent output: `sendStream()` reports reply text as the
agent produces it. See the [client reference](https://docs.amika.dev/sdks/typescript/client.md#agent-sessions).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.