Prerequisites
Before you begin, make sure you have:- Python 3.10 or above
- macOS Sierra+, Ubuntu 22.04+, WSL2, or Windows 10+
- An internet connection
Step 1: Install Nova Act
Install the SDK using pip:Step 2: Get your API key
Visit the Nova Act playground
Navigate to nova.amazon.com/act and sign in
For production deployments, use IAM-based authentication. See the authentication guide for details.
Step 3: Run your first workflow
Create a file calledfirst_workflow.py:
- Open a Chrome browser
- Navigate to the starting page
- Execute your task using AI-powered automation
- Close the browser when complete
Don’t interact with the browser while
act() is running, as the model won’t know about your manual changes.Step 4: Extract structured data
Now let’s extract information from a web page using Pydantic schemas:act_get() method returns structured data that matches your Pydantic schema.
Step 5: Interactive mode
You can also use Nova Act interactively in the Python shell:Common patterns
Search and filter
Form filling
Multi-step workflow
Tips for better results
Be specific and direct
Be specific and direct
\u274c Don’t:
"Let's see what products are available"\u2705 Do: "Navigate to the products page"Provide complete instructions
Provide complete instructions
\u274c Don’t:
"Book a hotel"\u2705 Do: "Book a hotel in Houston from March 15-17 for two adults under $150 per night"Break up large tasks
Break up large tasks
\u274c Don’t:
"Search for products, add to cart, checkout, and get confirmation number"\u2705 Do: Break into separate act() calls for each major stepNext steps
Core concepts
Learn about workflows, browser automation, and prompting
Data extraction
Master structured data extraction with Pydantic
Deployment
Deploy workflows to AWS for production use
API reference
Explore the complete NovaAct API
Troubleshooting
Import error: No module named 'nova_act'
Import error: No module named 'nova_act'
Make sure Nova Act is installed in your current Python environment:If not installed, run:
API key not working
API key not working
Verify your API key is set correctly:Make sure you exported it in the same terminal session where you’re running your script.
Browser doesn't open
Browser doesn't open
Nova Act may need to install Playwright browsers on first run. Wait 1-2 minutes for the initial setup to complete.Optionally, pre-install Chrome:
Task fails or gets stuck
Task fails or gets stuck
Try these improvements:
- Make your prompt more specific
- Break the task into smaller steps
- Add hints about how to use specific UI elements
- Reduce the number of steps needed (aim for under 30)
Learn more
- Installation guide - Detailed installation instructions
- Authentication - API key vs IAM authentication
- Prompting best practices - Write better prompts
- Code samples - Real-world examples