Connect with REST

BETA

Agent Gateway is in BETA, and we're continuing to expand its capabilities. Your feedback helps shape what we build next—reach out to us through Relewise Support.

Use the REST API to make HTTP requests to Agent Gateway. Before connecting, complete the configuration and Personal Access Token steps in Get Started.

In My Relewise, open Administration > Agent Gateway > Connection Guide, then select the REST API tab for connection settings.

Configure the Connection

The REST API base URL is:

https://my.relewise.com/agents/api/v1

Send your Personal Access Token with every request:

Authorization: Bearer <personal-access-token>

Use the interactive API reference for endpoint paths and request formats. The OpenAPI specification is also available for client tooling.

Verify the Personal Access Token

Send a GET request to the Identity endpoint to verify the token:

GET https://my.relewise.com/agents/api/v1/me
Authorization: Bearer <personal-access-token>

The response contains:

• The authenticated user's display name and email address.
• Non-secret metadata about the Personal Access Token, including its name, optional description, and expiration time.
• Dataset references that are visible to the authenticated user and allowed by the token's Dataset Scope, grouped by License. Both License and Dataset references use id for their identifiers.

A valid token returns 200 OK, including when no Datasets are available. Missing, invalid, expired, and revoked tokens return 401 Unauthorized.

Select a Dataset

Use the selected Dataset's id in requests that require a Dataset ID. For example, check its Agent Gateway settings with:

GET https://my.relewise.com/agents/api/v1/datasets/{datasetId}/core/dataset
Authorization: Bearer <personal-access-token>

Browse Areas for available endpoints and pagination guidance. For connection or access issues, see Troubleshooting and FAQ.