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, ensure that you have Use Agent Gateway permission and that the REST API is enabled for the Dataset. See Security and Permissions and Configuration.

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 a bearer token with every request. In the examples below, replace <token> with your OAuth access token or Personal Access Token:

Authorization: Bearer <token>

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

Authenticate with OAuth

OAuth is recommended for interactive clients. Agent Gateway supports Authorization Code flow with S256 PKCE and multiple client registration methods. See OAuth for discovery, registration, scopes, and refresh-token guidance.

Authenticate with a Personal Access Token

For scripts and integrations that can securely store a bearer token, create a Personal Access Token and use its value as <token> in the requests below.

Verify the Credential

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

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

The response contains:

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

A valid credential returns 200 OK, including when no Datasets are available. Missing, invalid, expired, and revoked credentials 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 <token>

Dataset Endpoints

The relative REST paths on Area pages use this Dataset base URL:

https://my.relewise.com/agents/api/v1/datasets/{datasetId}

Replace {datasetId} with the selected Dataset's ID and append the documented path. For example, /core/dataset produces the request above.

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