API Documentation
- API Keys Overview & Getting Started
- Creating & Managing API Keys
- Authentication & Scopes
- Read-Only Endpoints Reference
- Error Handling & Troubleshooting
- Best Practices & Security
- Python Integration Examples
- JavaScript Integration Examples
- Bulk Import API, AIRTA & Imported Reports
- AILP - LLM compliance SDK (@airtasystems/ailp)
API Keys Overview & Getting Started
Jan 15, 2025
Overview
API keys provide read-only programmatic access to the AIRTA Systems API. They are designed for automated data retrieval, integrations, and server-to-server communication.
The AIRTA Systems API provides access to team-based risk assessment data, where professional AI Safety Research teams (not individual researchers) conduct agentic and human-validated testing within structured project engagements. All data follows The Consolidated AI Product Safety Pipeline model.
Key Features
- ✅ Read-only access - Can retrieve data from all read endpoints
- ✅ Long-lived - Valid until revoked or expired
- ✅ Scoped permissions - Granular control over what data can be accessed
- ✅ IP restrictions - Optional IP whitelisting for enhanced security
- ✅ Stateless - No session management required
Use Cases
API keys are ideal for:
- Automated reporting and data synchronization
- Integration with GRC platforms and compliance tools
- Building custom dashboards and analytics
- Server-to-server data retrieval
- CI/CD pipeline integrations
- Third-party service integrations
- Accessing team data, team performance metrics, and team-attributed submissions from agentic and human-validated testing
- Retrieving compliance reports from The Consolidated AI Product Safety Pipeline
Limitations
API keys are read-only and cannot be used for:
- Creating or updating submissions
- Creating incident reports
- Creating FRIA assessments
- Sending messages
- Any write operations
For write operations, you must use session-based authentication through the web interface.
Next Steps
- Learn how to create and manage API keys
- Understand authentication and scopes
- Explore available endpoints