Skip to main content
POST
Refine test description

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app.

Body

application/json
description
string
required

Rough description of what to test, in your own words.

Required string length: 1 - 500
Example:

"check that new projects show up on the dashboard"

Response

The suggested name and goal.

A test name and goal written from a rough description.

name
string
required

Short name for the test.

Example:

"Create a project"

goal
string
required

The goal, rewritten as steps the testing agent can follow.

Example:

"Sign up, create a project called Launch, and check that it appears on the dashboard."