AIVA

AIVA How to... API

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

GitHub OpenAPI

Operations 3

GET / GET / #
POST /v2/batch-executions POST /v2/batch-executions #
GET /v2/tests Run tests via API #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/aiva-works/openapi/_ae-authored/aiva-works-how-to-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/aiva-works/json-schema/aiva-works-post-v2-batch-executions-request-schema.json

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aiva-works:how-to-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aiva-works-how-to-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: AIVA How to... API
  version: '2026-11-01'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-01: 3 operation(s) read from 2 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/how-to/access-local-applications
  - https://app.aiva.works/docs/how-to/run-tests-via-api
  x-docs-section: how-to
servers:
- url: https://api.aiva.works
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://app.aiva.works/docs/how-to/access-local-applications
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl http://your-app-url from the machine running the Gateway Client \n Check firewall rules and network configuration. The\
          \ machine running the Gateway Client must reach the application's ports and your internal DNS (see Firewall requirements ). \n Ensure\
          \ URLs in tests match exactly (including http/https) \n If using Docker, try replacing 'localhost' with 'host.docker.internal' or switch\
          \ to using a p"
  /v2/batch-executions:
    post:
      operationId: post_v2_batch_executions
      tags:
      - Batch Executions
      summary: POST /v2/batch-executions
      x-source: https://app.aiva.works/docs/how-to/run-tests-via-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV2BatchExecutionsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -L ''https://api.aiva.works/v2/batch-executions'' \ -H ''Content-Type: application/json'' \ -H ''Accept: application/json''
          \ -H ''X-API-KEY: <X-API-KEY>'' \ -d ''{ "name": "CI Batch", "labels": [ "smoke", "regression" ], "maxNumberOfAgents": 3, "globalVariableOverrides":
          { "username": "testuser", "password": "testpass" }, "variableOverridesPerTest": { "123e4567-e89b-12d3-a456-426614174000": { "expect'
  /v2/tests:
    get:
      operationId: get_v2_tests
      tags:
      - Tests
      summary: Run tests via API
      x-source: https://app.aiva.works/docs/how-to/run-tests-via-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
security:
- apiKey: []
components:
  schemas:
    PostV2BatchExecutionsRequest:
      type: object
      properties:
        name:
          type: string
        labels:
          type: array
          items:
            type: string
        maxNumberOfAgents:
          type: integer
        globalVariableOverrides:
          type: object
          properties:
            username:
              type: string
            password:
              type: string
        variableOverridesPerTest:
          type: object
          properties:
            123e4567-e89b-12d3-a456-426614174000:
              type: object
              properties:
                expectedText:
                  type: string
                username:
                  type: string
        gatewayName:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
tags:
- name: Api
- name: Batch Executions
- name: Tests