AIVA API Reference API
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.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/aiva-works:api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: AIVA API Reference API
version: '2026-11-01'
description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 15 operation(s) read from 15 public documentation page(s) (each
operation names its page in x-source). This is not the provider''s published contract; AIVA has published no machine-readable contract that
the pipeline could find. Engine: oss.'
x-evidence-tiers:
code-example: 3
documentation: 15
pages-with-code: 2
pages-read: 23
x-generated-from: documentation
x-provenance: generated
x-authored-by: API Evangelist
x-generated: '2026-11-01'
x-generator: generate-contract-from-docs.py
x-engine: oss
x-sources:
- https://app.aiva.works/docs/api/batch-executions-cancel-batch-execution-v-2
- https://app.aiva.works/docs/api/batch-executions-get-batch-execution-ctrf-v-2
- https://app.aiva.works/docs/api/batch-executions-get-batch-execution-j-unit-v-2
- https://app.aiva.works/docs/api/batch-executions-get-batch-execution-v-2
- https://app.aiva.works/docs/api/batch-executions-get-batch-executions-v-2
- https://app.aiva.works/docs/api/batches-delete-batch-v-2
- https://app.aiva.works/docs/api/batches-get-batch-v-2
- https://app.aiva.works/docs/api/batches-get-batches-v-2
- https://app.aiva.works/docs/api/batches-trigger-batch-v-2
- https://app.aiva.works/docs/api/gateways-get-gateways-v-2
- https://app.aiva.works/docs/api/gateways-is-gateway-ready-v-2
- https://app.aiva.works/docs/api/test-runs-cancel-test-run-v-2
- https://app.aiva.works/docs/api/test-runs-get-test-runs-v-2
- https://app.aiva.works/docs/api/tests-delete-test-v-2
- https://app.aiva.works/docs/api/tests-run-test-v-2
x-docs-section: api
servers:
- url: https://api.aiva.works
paths:
/v2/batch-executions:
get:
operationId: get_v2_batch_executions
tags:
- Batch Executions
summary: Lists batch executions, newest first, with their status and test counts.
description: Lists batch executions, newest first, with their status and test counts.
x-source: https://app.aiva.works/docs/api/batch-executions-get-batch-executions-v-2
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/batch-executions/{executionid}:
get:
operationId: get_v2_batch_executions_executionid
tags:
- Batch Executions
summary: Get batch execution
description: Returns one batch execution with its status and test counts. Its test runs are listed by GET /v2/test-runs?batchExecutionId={executionId}.
x-source: https://app.aiva.works/docs/api/batch-executions-get-batch-execution-v-2
parameters:
- name: executionid
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/batch-executions/{executionid}/cancel:
put:
operationId: put_v2_batch_executions_executionid_cancel
tags:
- Batch Executions
summary: Cancel batch execution
description: Cancels a batch execution.
x-source: https://app.aiva.works/docs/api/batch-executions-cancel-batch-execution-v-2
parameters:
- name: executionid
in: path
required: true
schema:
type: string
responses:
'202':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/batch-executions/{executionid}/ctrf:
get:
operationId: get_v2_batch_executions_executionid_ctrf
tags:
- Batch Executions
summary: Batch execution as a CTRF report
description: The batch execution and its test runs, as one CTRF report.
x-source: https://app.aiva.works/docs/api/batch-executions-get-batch-execution-ctrf-v-2
parameters:
- name: executionid
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/batch-executions/{executionid}/junit:
get:
operationId: get_v2_batch_executions_executionid_junit
tags:
- Batch Executions
summary: Batch execution as JUnit XML
description: The batch execution and its test runs, as one JUnit XML document.
x-source: https://app.aiva.works/docs/api/batch-executions-get-batch-execution-j-unit-v-2
parameters:
- name: executionid
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/batches:
get:
operationId: get_v2_batches
tags:
- Batches
summary: Lists the batches defined in AIVA.
description: Lists the batches defined in AIVA.
x-source: https://app.aiva.works/docs/api/batches-get-batches-v-2
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/batches/{batchid}:
delete:
operationId: delete_v2_batches_batchid
tags:
- Batches
summary: Delete a defined batch
description: Deletes a defined batch.
x-source: https://app.aiva.works/docs/api/batches-delete-batch-v-2
parameters:
- name: batchid
in: path
required: true
schema:
type: string
responses:
'204':
description: Success (status as documented)
x-evidence:
kind: documentation
get:
operationId: get_v2_batches_batchid
tags:
- Batches
summary: Get a defined batch
description: Returns one defined batch.
x-source: https://app.aiva.works/docs/api/batches-get-batch-v-2
parameters:
- name: batchid
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/batches/{batchid}/trigger:
post:
operationId: post_v2_batches_batchid_trigger
tags:
- Batches
summary: Trigger a defined batch
description: Runs a defined batch now and returns the ID of the started batch execution.
x-source: https://app.aiva.works/docs/api/batches-trigger-batch-v-2
parameters:
- name: batchid
in: path
required: true
schema:
type: string
responses:
'202':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/gateways:
get:
operationId: get_v2_gateways
tags:
- Gateways
summary: Lists the gateways tests can run through.
description: Lists the gateways tests can run through.
x-source: https://app.aiva.works/docs/api/gateways-get-gateways-v-2
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/gateways/{gatewayid}/ready:
get:
operationId: get_v2_gateways_gatewayid_ready
tags:
- Gateways
summary: Check gateway readiness
description: Whether the gateway is connected and ready to run tests.
x-source: https://app.aiva.works/docs/api/gateways-is-gateway-ready-v-2
parameters:
- name: gatewayid
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/test-runs:
get:
operationId: get_v2_test_runs
tags:
- Test Runs
summary: Lists test runs, newest first; runs that have not started yet come first.
description: Lists test runs, newest first; runs that have not started yet come first. Recording and versioning runs are not listed.
x-source: https://app.aiva.works/docs/api/test-runs-get-test-runs-v-2
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/test-runs/{testrunid}/cancel:
put:
operationId: put_v2_test_runs_testrunid_cancel
tags:
- Test Runs
summary: Cancel test run
description: Endpoint for cancellation of a test run.
x-source: https://app.aiva.works/docs/api/test-runs-cancel-test-run-v-2
parameters:
- name: testrunid
in: path
required: true
schema:
type: string
responses:
'202':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/tests/{testid}:
delete:
operationId: delete_v2_tests_testid
tags:
- Tests
summary: Delete a defined test
description: Deletes a defined test, across all of its versions.
x-source: https://app.aiva.works/docs/api/tests-delete-test-v-2
parameters:
- name: testid
in: path
required: true
schema:
type: string
responses:
'204':
description: Success (status as documented)
x-evidence:
kind: documentation
/v2/tests/{testid}/runs:
post:
operationId: post_v2_tests_testid_runs
tags:
- Tests
summary: Enqueues a run of the test and returns the test run ID.
x-source: https://app.aiva.works/docs/api/tests-run-test-v-2
parameters:
- name: testid
in: path
required: true
schema:
type: string
responses:
'202':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/PostV2TestsTestidRunsResponse'
x-evidence:
kind: documentation
security:
- apiKey: []
components:
schemas:
PostV2TestsTestidRunsResponse:
type: object
properties:
Location:
type: string
description: URL of the created test run.
securitySchemes:
apiKey:
type: apiKey
in: header
name: X-API-KEY
tags:
- name: Batch Executions
- name: Batches
- name: Gateways
- name: Test Runs
- name: Tests