GuidesAPI Reference
API Reference

OpenAPI specification

Retrieves OpenAPI specification of this API

Headers
string

User-provided token that can be used to trace a request or a group of requests sent to the service. Can be any string, but UUID is recommended. It will be echoed in the response.

string

Indicates preferred media types for the response. The server uses content negotiation (see RFC 9110) to select the best option and informs the choice in the Content-Type response header. Supported media types are application/json, application/x-yaml and text/x-yaml. If this header is missing or specifies any other media type, the response will be in JSON format.

string

Indicates preferred content encodings in the response. The server uses content negotiation (see RFC 9110) to select the best option and informs the choice in the Content-Encoding response header. Supported codings are: 'gzip', 'deflate', 'br'. For any other value, or if this header is missing, the response will be uncompressed.

Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/x-yaml
text/x-yaml