Overview

This documentation is intended for developers who want to write applications on top of the AutoRegex API. The service is provided via a simple URL-based interface which can directly be accessed through an HTTP POST request.

<aside> 💡 Access to this API is exclusive to AutoRegex Pro users

</aside>

Quick Start

Base Path

The API endpoint is

<https://api.autoregex.xyz/>

Parameters

The API accepts three parameters as shown below

Parameter Description Example
input_type Type of input fed into the API regex
prompt Input prompt fed into the API match 3 digits followed by a vowel
api_key Obtained from https://autoregex.xyz/settings D1grwurrwATu0mc5BYNT3DbiAZF2

For POST requests, parameters should be encoded as JSON with a Content-Type of application/json

Response

Responses are encoded as JSON where the generation can be accessed from the message object

For example, a cURL request such as