API key authentication
When using API key authentication, access and use are subject to the nova.amazon.com Terms of Use.
- Local development and testing
- Experimenting with Nova Act features
- Prototyping workflows
- Previewing new Nova Act model versions
Get your API key
Visit the Nova Act playground
Navigate to nova.amazon.com/act and sign in
Use the API key in your code
Once the environment variable is set, you can use Nova Act without additional configuration:IAM-based authentication
When using IAM authentication and deploying to the Nova Act AWS service, your AWS Service Terms and/or Customer Agreement apply.
- Integration with AWS Identity and Access Management
- Fine-grained access control
- Audit logging via CloudTrail
- No API key management overhead
Prerequisites
- AWS account with Nova Act service access
- Configured AWS credentials (via AWS CLI, environment variables, or IAM role)
- Permissions to create and manage Nova Act workflow definitions
Use IAM authentication with Workflows
IAM authentication is used automatically when you create aWorkflow:
- Environment variables (
AWS_ACCESS_KEY_ID,AWS_SECRET_ACCESS_KEY) - AWS credentials file (
~/.aws/credentials) - IAM role (when running on EC2, ECS, or Lambda)
Configure AWS credentials
- AWS CLI
- Environment variables
- Credentials file
- Custom profile
Configure credentials using the AWS CLI:Enter your:
- AWS Access Key ID
- AWS Secret Access Key
- Default region (e.g.,
us-east-1) - Default output format
Default boto session
The SDK will instantiate a default boto3 session if AWS credentials are already configured in your environment.
boto_session_kwargs and don’t use an API key, the workflow will automatically load AWS credentials using boto3’s default credential chain. See boto3 documentation for details.
Authentication decision guide
Choose your authentication method based on your use case:| Scenario | Recommended Authentication |
|---|---|
| Local development | API key |
| Testing and prototyping | API key |
| Production workflows | IAM |
| AWS-hosted applications | IAM |
| CI/CD pipelines | IAM |
| Sharing with team | IAM (with proper IAM policies) |
Required permissions
For IAM-based authentication, your IAM user or role needs the following permissions:Troubleshooting
API key not working
API key not working
Verify that:
- The API key is correctly set in the
NOVA_ACT_API_KEYenvironment variable - The API key hasn’t expired
- You’re connected to the internet
- The nova.amazon.com service is accessible from your location
IAM authentication failing
IAM authentication failing
Check that:
- AWS credentials are properly configured (run
aws sts get-caller-identityto test) - Your IAM user/role has the required Nova Act permissions
- The region is set correctly (Nova Act is available in specific regions)
- Your AWS credentials haven’t expired
Which authentication should I use?
Which authentication should I use?
- Use API key for quick development and testing
- Use IAM for production deployments and AWS-integrated applications
- You can switch between authentication methods without changing your code (just use or omit the
workflowparameter)
Next steps
Quickstart
Build your first Nova Act workflow
Workflows
Learn about workflow orchestration
Deployment
Deploy workflows to AWS
Security
Security best practices