General

This document covers some general API conventions including authentication.

URL

The base URL for our API is https://api.testable.io.

Authentication

All API requests must contain an API key for authentication. Generate a new API Key under Settings -> API Keys on the Testable product site.

API Key

There are two ways to pass the API key with your request.

  1. X-Testable-Key HTTP header. Example: curl --header "X-Testable-Key: [api-key]" https://api.testable.io/agents
  2. key query param. Example: curl https://api.testable.io/agents?key=[api-key]