Back to home

API Documentation

Integrate with Testr programmatically

Introduction

Getting started with the Testr API

The Testr API allows you to programmatically create and manage tests, access results, and integrate with your CI/CD pipeline.

All API requests require authentication using an API key. You can create and manage API keys in your account settings.

Authentication

How to authenticate with the Testr API

All API requests must include your API key in the X-API-Key header.

curl -X GET https://testr.pro/api/test-definitions \
  -H "X-API-Key: testr_your_api_key"

Replace testr_your_api_key with your actual API key.

API Endpoints

Available API endpoints and their usage

Test Definitions

GET
/api/test-definitions

List all test definitions for the authenticated user.

POST
/api/test-definitions

Create a new test definition.

GET
/api/test-definitions/{id}

Get a specific test definition by ID.

Test Execution

POST
/api/test/create

Create and run a new test.

GET
/api/test/status/{id}

Get the status of a test run.

Example Usage

Code examples for common API operations

Create and Run a Test

curl -X POST https://testr.pro/api/test/create \
  -H "X-API-Key: testr_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Homepage Test",
  "targetUrl": "https://example.com",
  "testType": "step",
  "steps": [
    "Click the login button",
    "Enter email test@example.com",
    "Enter password test1234",
    "Click the submit button",
    "Verify that the welcome message is displayed"
  ]
}'

Check Test Status

curl -X GET https://testr.pro/api/test/status/123e4567-e89b-12d3-a456-426614174000 \
  -H "X-API-Key: testr_your_api_key"

Rate Limits

API usage limits and quotas

The Testr API has the following rate limits:

  • 60 requests per minute
  • 1000 requests per day
  • Test creation is limited by your available credits

If you need higher limits, please contact our support team.

Support

Get help with the Testr API

If you need help with the Testr API, please contact our support team at api-support@testr.pro.

You can also check our API FAQ for answers to common questions.