Skip to main content

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.

Amika ships official SDKs that wrap the hosted API at app.amika.dev. Use them when you want to drive sandboxes from a program rather than the shell.

​
Available SDKs

TypeScript

@amika/sdk — sandboxes, sessions, secrets, agent invocations.

TypeScript source

Read the source on GitHub.
More languages are coming. In the meantime, you can call the HTTP API directly — see API reference for the OpenAPI spec.

​
When to use the SDK vs. the CLI

Use caseTool
Day-to-day shell work, ad-hoc sandbox creationCLI
Building automated pipelines, web apps, or background jobsSDK
One-off scripts to drive an agent through a taskEither — see Programmatic usage
CI: spin up a sandbox per PRSDK (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 a token via accessToken or tokenSource.
  • It does not run shell commands. Use SSH (via getSSH or the SSH guide) when you need a shell.
  • It does not stream agent output. agentSend blocks until the agent finishes and returns the full result.