Skip to main content
API Reference

REST API Documentation

Integrate TestForge into your workflow with our comprehensive REST API.

https://api.testforge.dev/v1

Authentication

All API requests require authentication using a Bearer token. Generate your API key in the dashboard settings.

  • Include your API key in the Authorization header
  • Keep your API key secure - never expose it in client-side code
  • Rotate keys regularly and revoke compromised keys immediately
Example Request
curl -X GET "https://api.testforge.dev/v1/tests" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Endpoints

Tests
Manage test suites and individual tests
GET
/api/v1/tests
List all tests
POST
/api/v1/tests
Create a new test
GET
/api/v1/tests/:id
Get test details
PUT
/api/v1/tests/:id
Update a test
DELETE
/api/v1/tests/:id
Delete a test
POST
/api/v1/tests/:id/run
Execute a test
Recordings
Browser session recordings and actions
GET
/api/v1/recordings
List recordings
POST
/api/v1/recordings
Start a recording session
PUT
/api/v1/recordings/:id
Update recording
POST
/api/v1/recordings/:id/stop
Stop recording
GET
/api/v1/recordings/:id/actions
Get recorded actions
Runs
Test execution history and results
GET
/api/v1/runs
List test runs
GET
/api/v1/runs/:id
Get run details
GET
/api/v1/runs/:id/logs
Get execution logs
GET
/api/v1/runs/:id/screenshots
Get screenshots
POST
/api/v1/runs/:id/cancel
Cancel running test
Projects
Project and organization management
GET
/api/v1/projects
List projects
POST
/api/v1/projects
Create project
GET
/api/v1/projects/:id
Get project details
PUT
/api/v1/projects/:id/settings
Update settings
GET
/api/v1/projects/:id/members
List members
Webhooks
Event notifications and integrations
GET
/api/v1/webhooks
List webhooks
POST
/api/v1/webhooks
Create webhook
DELETE
/api/v1/webhooks/:id
Delete webhook
POST
/api/v1/webhooks/:id/test
Send test event
Rate Limits
API requests are limited to 1000/hour for free tier, 10000/hour for Pro.
Response Format
All responses are in JSON format with consistent error handling.
SDK Support
Official SDKs available for Node.js, Python, Go, and Ruby.