Allowl Query

Overview

The Allowl Query endpoint uses the POST method to submit a query via a JSON object in the request body. The result of the query are given as a JSON object in the response body. The structure and capabilities of an Allowl query are given by the Allowl Query Language.

Structure of query input

Structure of a query result

A "Hello, World" Query Request

The following query is a trivial "hello, world" example. You may click on the beaker icon to execute it as is or to compose and execute a different query using the instructions from the preceding pages.

	{
    "query": "Hello, world!"
	}

"Hello, World" Response

If successful, the endpoint will return a JSON object containing the query result.

Return & Error Codes

	{
    "result": "Hello world!"
	}

Credits

Grammar consistency testing and generation of images representing elements of the Allowl grammar were aided by Gunther Rademacher's open source Railroad Diagram Generator program. An online version is hosted at bottlecaps.de/rr/. The software was used with permission and according to its Apache License terms.