Deploy Your Agents
This guide shows you how to deploy AI Agents with the videosdk-agents python package. Once your AI Agent is ready to use, you need to create an AI Deployment. The AI Deployment is responsible for running your AI Agent. Before proceeding, ensure you have completed the steps under Prerequisites.
Prerequisites
To deploy your AI Deployment, make sure you have:
- Created an AI Deployment using the Create AI Deployment API.
- A VideoSDK authentication token (generate from VideoSDK Dashboard)
YAML Configuration
Create a videosdk.yaml
file with the following structure:
version: "1.0"
deployment:
id: your_ai_deployment_id
entry:
path: entry_point_for_deployment
env: # Optional to run your agent locally
path: "./.env"
secrets:
VIDEOSDK_AUTH_TOKEN: your_auth_token
deploy:
cloud: true
Field Descriptions
Field | Description |
---|---|
deployment.id | The deploymentId obtained from the Create AI Deployment API |
deployment.entry.path | Path to the entry point script for your AI Deployment. |
env.path | Path to your .env file, used only when running the agent locally. |
secrets.VIDEOSDK_AUTH_TOKEN | Your VideoSDK auth token (required for deployment). |
deploy.cloud | Set to true to allow deploying the deployment to VideoSDK Cloud, when using the deploy command. Use false to avoid accidental deploys. |
CLI Commands
-
Run the AI Deployment locally for Testing.
videosdk run
-
Deploy the AI Deployment.
videosdk deploy
Next Steps
After deploying your AI Deployment, you can start using it by:
- Creating a new session using the Start Session API
- Ending the session using the End Session API
Got a Question? Ask us on discord