API Endpoints

Complete list of available API endpoints.

API Endpoints

Complete reference for all Automated Future API endpoints.

Projects

List Projects

GET /v1/projects

Returns a list of all projects you have access to.

Response:

{
  "data": [
    {
      "id": "proj_123...",
      "name": "My Project",
      "created_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Get Project

GET /v1/projects/:id

Returns details for a specific project.

Test Runs

Create Test Run

POST /v1/test-runs

Submit test results to Automated Future.

Request Body:

{
  "project_id": "proj_123...",
  "results": [
    {
      "name": "Test name",
      "status": "passed",
      "duration_ms": 1234
    }
  ]
}

Response:

{
  "data": {
    "id": "run_456...",
    "status": "completed",
    "test_count": 1
  }
}

List Test Runs

GET /v1/test-runs?project_id=proj_123

Returns test runs for a project.

Query Parameters:

• project_id (required) - Project ID
• page (optional) - Page number (default: 1)
• per_page (optional) - Results per page (default: 20, max: 100)
• status (optional) - Filter by status: passed, failed, skipped

Test Results

Get Test Result

GET /v1/test-results/:id

Returns details for a specific test result.

Webhooks

List Webhooks

GET /v1/webhooks

Returns configured webhooks for your account.

Create Webhook

POST /v1/webhooks

Request Body:

{
  "url": "https://example.com/webhook",
  "events": ["test.failed", "test.flaky"]
}

Error Responses

All errors follow this format:

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid project ID",
    "details": {}
  }
}

Common Error Codes:

• invalid_request - Request validation failed
• unauthorized - Invalid or missing API key
• forbidden - Insufficient permissions
• not_found - Resource not found
• rate_limited - Too many requests