API reference

Enterprise deployment API and MCP

Use the Enterprise API to create, monitor, and tear down AI Deploy agent deployments from your own tools. The local MCP server wraps the same API for coding assistants.

Auth

Send API keys in the Authorization header as Bearer AIDEPLOY_KEY.

Access

Command Center includes deployment API and MCP access. Mass deployments require Enterprise access.

Keys

Create and revoke scoped keys from Account, API keys after signing in.

Endpoints

GET/api/enterprise/v1/capabilities

Check API access and available Enterprise features.

GET/api/enterprise/v1/deployments

List deployments created through the Enterprise API.

POST/api/enterprise/v1/deployments

Create one or more agent deployments.

GET/api/enterprise/v1/deployments/[deployId]

Fetch one deployment and refresh its current status.

POST/api/enterprise/v1/deployments/[deployId]/destroy

Destroy a deployment that belongs to your account.

GET/api/enterprise/v1/keys

List your scoped API keys.

POST/api/enterprise/v1/keys

Create a scoped API key. The plaintext key is shown once.

DELETE/api/enterprise/v1/keys/[keyId]

Revoke an API key.

Create a deployment

curl -X POST https://aideploy.co/api/enterprise/v1/deployments \
  -H "Authorization: Bearer $AIDEPLOY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "acme-prod",
    "cloudProvider": "digitalocean",
    "cloudToken": "dop_v1_...",
    "region": "nyc3",
    "serverSize": "starter",
    "agentCount": 1,
    "tailscaleAuthKey": "tskey-auth-...",
    "selectedAIProviders": ["openai"],
    "billingAcknowledged": true
  }'

Scopes

  • deployments:read - read deployments and status
  • deployments:write - create deployments
  • deployments:destroy - destroy deployments
Enterprise API and MCP Docs - AI Deploy by Belong