Updated August 21, 2026

Quickstart

Four steps. Pick the trigger that matches how you already run tests.

1. Confirm the client

If Velo does not support the app client, the suite cannot run remotely. Check the support matrix.

Remote today: Web and SAP GUI for Java. SAP GUI for Windows is local / debug only — the same Robot suite runs remotely on the Java client.

2. Create an API key

In the dashboard: Settings → API Keys. Machine clients send it as:

Authorization: Bearer velo_...

3. Trigger a run

Robot Framework (engine-native — also how Copado CRT talks to Velo):

pip install robotframework-velo-cli
velo login --api-base https://api.velo.aster.pro --engine robot-sap
velo robot ./tests

Use --engine robot-web for Web via Robot Browser Library.

REST (Rev-Trac, custom CI, any HTTP client):

  1. Upload a suite zip: POST /suites with engine (robot-sap, robot-web, or playwright).
  2. Trigger: POST /executions with suite_id, strategy, optional filter, variables, callback_url.
  3. Poll GET /runs/{id} or stream GET /runs/{id}/stream.

See Integrate with the Velo API.

4. Collect artifacts

On completion the run exposes report, log, and (when the client has a display) session video. The CLI downloads output.xml, log.html, and report.html to ./results/.

Next