Deployments.ai Docs

Overview

What Deployments.ai is, who it is for, and the four ways to work with it: console, CLI, SDK, and HTTP API.

Deployments.ai is a multi-tenant control plane and runtime for AI agents. You describe an agent in a manifest, publish it as an immutable release, deploy that release into an environment, and send it work. The platform runs the agent, streams its output, records every run against the exact release that executed, and meters what it used.

These docs are for two groups of readers:

  • Engineers who build on the platform through the CLI, the TypeScript SDK, the HTTP API, or the management console.
  • Operators who install and run the platform.

How an agent gets from idea to answer

Every agent follows the same path, whatever triggers it.

  1. Define. An agent definition holds a draft AgentManifestV1: instructions, model, tools, memory, sandbox, and triggers.
  2. Release. Publishing the definition creates an immutable release with a SHA-256 content hash and a release number.
  3. Deploy. A deployment pins one release to one environment and binds environment-specific tool authorizations.
  4. Run. A message to a deployment starts a run on a thread. The run records which deployment and release executed it.

A run can start from the API, a chat client, email, a schedule, a heartbeat, a webhook, or a workflow. All of them produce the same thread and run records. Core concepts explains each resource.

Four ways in

All four entry points call the same public API. Pick the one that fits the job.

Entry pointUse it toStart here
CLI (deployments)Script tenancy, agents, runs, and operations from a terminal or CI job. Every API operation has a command.CLI overview
TypeScript SDKCall the API from Node.js code with one typed function per operation.SDK overview
HTTP APIIntegrate from any language with JSON over HTTPS.API overview
Management consoleInspect agents, releases, deployments, runs, traces, evaluations, and usage in a browser.Management console

The SDK is generated from the API contract, and a test checks that every API operation has a CLI command. Each API reference page shows the matching SDK function and CLI command.

Map of the docs

On this page