Relay

Appearance

First steps ​

Relay helps you manage, edit, and test API endpoints through organized collections.

thing

Collections ​

Relay uses Collections to group related endpoints together. Each collection serves as a workspace for a specific set of API endpoints.

Working with Endpoints ​

1. Editing a Request ​

  • Select an endpoint from your collection to open the Request Interface.
  • Customize the request details:
    • HTTP Method: Change between GET, POST, PUT, DELETE, etc.
    • URL: Update the endpoint path or query parameters.

2. Sending Requests and Viewing Responses ​

  • Click Send to execute the request.
  • You will automatically be redirected to the Response Page to view the results:
    • Status: Displays the HTTP status code (e.g., 200 OK, 404 Not Found).
    • Body: Shows the returned data payload.
    • Headers: Displays all returned header key-value pairs.