Api Workspace Template

This repo contains the code for running an agent-api and supports 2 environments:

1. dev: A development environment running locally on docker
2. prd: A production environment running on AWS ECS

Setup Workspace

1. Install uv: curl -LsSf https://astral.sh/uv/install.sh | sh

from the api-ws-template dir:

2. Install workspace and activate the virtual env:

./scripts/install.sh
source .venv/bin/activate

3. Setup workspace:

ag ws setup

4. Copy workspace/example_secrets to workspace/secrets:

cp -r workspace/example_secrets workspace/secrets

5. Optional: Create .env file:

cp example.env .env

Run Api Workspace Template locally

1. Install docker desktop

2. Set OpenAI Key

Set the OPENAI_API_KEY environment variable using

export OPENAI_API_KEY=sk-***

OR set in the .env file

3. Start the workspace using:

ag ws up

Open localhost:8000/docs to view the FastAPI docs.

4. Stop the workspace using:

as ws down

Next Steps:

• Run the Agent Api on AWS
• Read how to manage the development application
• Read how to manage the production application
• Read how to add python libraries
• Read how to format & validate your code
• Read how to manage secrets
• Add CI/CD
• Add database tables
• Read the Agent Api guide