# AIVA API Reference API

**Canonical:** https://apis.io/apis/aiva-works/api-api/  
**Provider:** AIVA — https://apis.io/providers/aiva-works/  
**Base URL:** https://api.aiva.works  
**Documentation:** https://app.aiva.works/docs/api

AIVA API Reference API is one of 3 APIs that [AIVA](https://apis.io/providers/aiva-works/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. The published artifact set on APIs.io includes an OpenAPI specification and 1 JSON Schema.

AIVA API Reference API as documented publicly: 15 operations. Contract generated from the documentation by API Evangelist (2026-11-01); not the provider's own document.

## Operations (15)

| Method | Path | Summary |
|---|---|---|
| GET | `/v2/batch-executions` | Lists batch executions, newest first, with their status and test counts. |
| GET | `/v2/batch-executions/{executionid}` | Get batch execution |
| PUT | `/v2/batch-executions/{executionid}/cancel` | Cancel batch execution |
| GET | `/v2/batch-executions/{executionid}/ctrf` | Batch execution as a CTRF report |
| GET | `/v2/batch-executions/{executionid}/junit` | Batch execution as JUnit XML |
| GET | `/v2/batches` | Lists the batches defined in AIVA. |
| DELETE | `/v2/batches/{batchid}` | Delete a defined batch |
| GET | `/v2/batches/{batchid}` | Get a defined batch |
| POST | `/v2/batches/{batchid}/trigger` | Trigger a defined batch |
| GET | `/v2/gateways` | Lists the gateways tests can run through. |
| GET | `/v2/gateways/{gatewayid}/ready` | Check gateway readiness |
| GET | `/v2/test-runs` | Lists test runs, newest first; runs that have not started yet come first. |
| PUT | `/v2/test-runs/{testrunid}/cancel` | Cancel test run |
| DELETE | `/v2/tests/{testid}` | Delete a defined test |
| POST | `/v2/tests/{testid}/runs` | Enqueues a run of the test and returns the test run ID. |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/aiva-works/openapi/_ae-authored/aiva-works-api-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/aiva-works/json-schema/aiva-works-post-v2-tests-testid-runs-response-schema.json

## Other AIVA APIs (2)

- [AIVA Cloud API](https://apis.io/apis/aiva-works/aiva-cloud-api/)
- [AIVA How to... API](https://apis.io/apis/aiva-works/how-to-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/aiva-works/api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/aiva-works/.