Skip to main content

Deploy & Version Commands

This section covers all CLI commands for deploying and managing versions of your AI agents on Agent Cloud.

Deploy

Create a new version of your agent on VideoSDK cloud.

Usage

videosdk agent deploy [NAME] [OPTIONS]

Arguments

ArgumentRequiredDescription
NAMENoOptional version name

Options

OptionShortDescriptionDefault
--image-iDocker image URL (e.g., myrepo/myagent:v1)From videosdk.yaml
--version-tagVersion tag (e.g., main/0.0.2)None
--min-replicaMinimum number of replicas0
--max-replicaMaximum number of replicas3
--profileCompute profile: cpu-small, cpu-medium, cpu-largecpu-small
--agent-idAgent IDFrom videosdk.yaml
--deployment-idDeployment IDFrom videosdk.yaml
--env-secretID of the environment secret set to useNone
--image-pull-secretName of the image pull secret for private registriesNone
--regionDeployment region (e.g., in002, us002)us002

Example Output

$ videosdk agent deploy --image myrepo/myagent:v1

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Creating Version
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Version Name my-agent's version
Agent ID abc123xyz
Deployment ID dep-456
Image myrepo/myagent:v1

────────────────────────────────────────

⠋ Creating Version...

✓ Version created successfully for agent: abc123xyz
Version ID ver-789

ℹ Next step: Check version status
videosdk agent version status -v ver-789

Examples

# Basic deployment
videosdk agent deploy --image myrepo/myagent:v1

# Named version with version tag
videosdk agent deploy my-version --image myrepo/myagent:v1 --version-tag main/0.0.1

# Deployment with secrets and custom profile
videosdk agent deploy --image myrepo/myagent:v1 --env-secret my-secrets --profile cpu-medium

# Deployment to specific region
videosdk agent deploy --image myrepo/myagent:v1 --region in002

List

List all versions for an agent deployment.

Usage

videosdk agent version list [OPTIONS]

Options

OptionDescriptionDefault
--agent-idAgent IDFrom videosdk.yaml
--deployment-idDeployment IDFrom videosdk.yaml
--pagePage number1
--per-pageItems per page10
--sortSort order: 1 (oldest first) or -1 (newest first)-1

Example Output

$ videosdk agent version list

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Listing Versions
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Agent ID abc123xyz
Deployment ID dep-456

┌────────────┬─────────┬──────────┬────────────┬─────────────┐
│ Version ID │ Status │ Region │ Profile │ Replicas │
├────────────┼─────────┼──────────┼────────────┼─────────────┤
│ ver-001 │ active │ us002 │ cpu-small │ 2/5 │
│ ver-002 │ inactive│ in002 │ cpu-medium │ 0/10 │
└────────────┴─────────┴──────────┴────────────┴─────────────┘

Examples

# List all versions
videosdk agent version list

# List versions for specific agent
videosdk agent version list --agent-id abc123

# Paginated listing
videosdk agent version list --page 2 --per-page 20

# Sort oldest first
videosdk agent version list --sort 1

Update

Update an existing version configuration.

Usage

videosdk agent version update [OPTIONS]

Options

OptionShortDescriptionRequired
--version-id-vVersion ID to updateYes
--min-replicaNew minimum replicasNo
--max-replicaNew maximum replicasNo
--profileNew compute profileNo
--image-pull-secretNew image pull secret nameNo
--env-secretNew environment secret nameNo

Example Output

$ videosdk agent version update -v ver123 --min-replica 3 --max-replica 15

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Updating Version
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Min Replicas 3
Max Replicas 15

⠋ Updating Version...

✓ Version updated successfully

Examples

# Update replica counts
videosdk agent version update -v ver123 --min-replica 2 --max-replica 10

# Update to larger profile
videosdk agent version update -v ver123 --profile cpu-large

# Update environment secrets
videosdk agent version update -v ver123 --env-secret new-secrets

Activate

Activate a version to start receiving traffic.

Usage

videosdk agent version activate [OPTIONS]

Options

OptionShortDescriptionRequired
--version-id-vVersion ID to activateYes

Example Output

$ videosdk agent version activate -v ver123

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Activating Version
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

⠋ Activating Version...

✓ Version activated successfully

Deactivate

Deactivate a version to stop receiving new traffic.

Usage

videosdk agent version deactivate [OPTIONS]

Options

OptionShortDescriptionRequired
--version-id-vVersion ID to deactivateYes
--forceForce deactivate even with active sessionsNo

Example Output

$ videosdk agent version deactivate -v ver123

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Deactivating Version
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

⠋ Deactivating Version...

✓ Version deactivated successfully

Examples

# Graceful deactivation
videosdk agent version deactivate -v ver123

# Force deactivation (terminates active sessions)
videosdk agent version deactivate -v ver123 --force

Status

Get the current status of a version.

Usage

videosdk agent version status [OPTIONS]

Options

OptionShortDescriptionRequired
--version-id-vVersion ID to checkYes

Example Output

$ videosdk agent version status -v ver123

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Getting Version Status
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Version ID ver123
Status active
Replicas 3/5 running
Health healthy

ℹ Next step: Start a session
videosdk agent session start -v ver123

Describe

Get detailed information about a version.

Usage

videosdk agent version describe [OPTIONS]

Options

OptionShortDescriptionRequired
--version-id-vVersion ID to describeYes

Example Output

$ videosdk agent version describe -v ver123

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Describing Version
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Version ID ver123
Agent ID abc123xyz
Deployment ID dep-456
Status active
Image myrepo/myagent:v1
Profile cpu-medium
Min Replicas 2
Max Replicas 10
Current Replicas 5
Region in002
Created At 2026-01-15 10:30:00

Quick Reference

CommandDescription
videosdk agent deployCreate a new version
videosdk agent version listList all versions
videosdk agent version updateUpdate version config
videosdk agent version activateActivate a version
videosdk agent version deactivateDeactivate a version
videosdk agent version statusGet version status
videosdk agent version describeGet detailed version info

Next Steps

  • Learn about managing secrets for your deployments
  • View sessions for your agents

Got a Question? Ask us on discord