aiva-actions/AIVA batch test run
Start an AIVA test batch via POST /v1/batches (see https://app.aiva.works/docs/api/batches-run-batch)
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 9, 2026
- License
- None
Pinned Snippet
uses: aiva-actions/run@ec33179aad4e5539591604408fc75edf912bea3d # v1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| apiKey | AIVA API key (store in a repository or organization secret) | yes | — |
| labels | Semicolon-separated labels used to select tests for the batch (e.g. "smoke,regression"). Required unless batchId is provided. | no | "" |
| batchId | Run a specific existing batch by its ID instead of selecting tests by labels. Mutually exclusive with labels. When set, only batchName may be overridden (maxNumberOfAgents, variable overrides and gatewayName are ignored). | no | "" |
| batchName | Custom name of the test batch | no | "" |
| maxNumberOfAgents | Maximum number of agents the batch can use for test execution. Defaults to 1. Ignored (and rejected) when batchId is provided. | no | "" |
| globalVariableOverrides | Override for all variables in a test Batch. | no | "" |
| variableOverridesPerTest | Override for variables in a test specified by test ID. | no | "" |
| gatewayName | Name of the gateway that is used by aiva-node during test. | no | "" |
| apiUrl | URL for starting a test batch | no | https://api.aiva.works/ |
| reportFilePath | Filepath where CTRF report should be saved | no | ./batch-ctrf.json |
| artifactName | Name of the uploaded artifact. Override when multiple invocations run in the same workflow to avoid name conflicts. | no | batch-status |
| pollPeriodSeconds | Wait time between retrying API call to check if batch finished | no | 10 |
| verbose | Set to true when additional output should be logged | no | false |
Outputs
| name | description |
|---|---|
| batchId | ID of the started test batch |
| batchUrl | URL to the batch in the AIVA UI |
| success | 'true' if all tests passed, 'false' otherwise |