Build with VistaCX

Explore projects, Systems, discoveries and draft test plans. Browse the API reference, schemas and request examples without signing in.

Documentation preview. Hosted API requests are not enabled yet. Examples are illustrative and do not access your workspace.

Loading specification…

Link to this operation

Request body schema

Build a request example

Edit parameters to explore the request format. Sending requests will be available after hosted API integration is complete.

Documented responses

Request example

Response

No request sent.

Response data will appear here.

Response headers

No request sent.

DEVELOPER GUIDE · BETA

Build with VistaCX

Use the API to prepare test configurations from your applications and retrieve saved results. This reference describes the beta API contract. Hosted requests are not enabled yet; workspace-scoped tokens will be required when access is available.

Understand the resources

Project: Groups related Systems and testing work.
System: The application or service under test. A connection identifies its phone, website or agent destination.
Discovery: A review objective and its available findings, used to inform test design.
Test plan: The expected outcome, scenarios, persona and success criteria. Draft status describes preparation, not a run result.
Run and evidence: A saved execution record and its results, transcript and recording metadata. Missing or partial evidence does not imply success.

Make your first request

When hosted access is available, obtain an API token with the required workspace permissions from your administrator.
Open List projects, review its parameters and copy the request example.
Review the documented response format. When API access is enabled, retain returned IDs for later requests. Replace example IDs with records you are allowed to access.

Send tokens in the Authorization header as Bearer tokens, never in URLs. This documentation preview does not accept tokens or send API requests. Copied examples contain placeholders. Your token determines workspace and Project access.

Prepare a test workflow

Create a Project and create a System.
Configure its connection; retain its ID and current version.
Optionally save a discovery configuration using available saved evidence.
Create a plan draft and supply scenarios and tester guidance.
Check readiness and resolve reported issues. Readiness is not permission to execute.
For existing runs, list saved runs and retrieve their results and transcript.

Retries, updates and pagination

For a create retry, reuse the same Idempotency-Key and unchanged body. Use a new key for a new create request. For updates, send the latest ETag in If-Match; reread after a version conflict. Follow nextCursor unchanged to retrieve another page. Restart listing if the cursor expires or the collection changes.

Handle errors

Check the HTTP status, error code and requestId. Correct invalid inputs before retrying; refresh invalid or expired tokens through your administrator. A 404 can mean a record is unavailable to your token. Respect Retry-After for rate limits. Keep requestId when contacting support; do not share your token.

Beta availability

This reference covers configuration preparation and read-only saved evidence. Hosted API access is pending; this site does not connect to your portal data. Starting or stopping tests, live discovery, audio playback and billing are not available here. Sample responses are illustrative, not actual test evidence.