Get Started with Agent Gateway

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 this guide to enable Agent Gateway for a Dataset and authenticate your first request.

Prerequisites

You need access to My Relewise and a Dataset where you can use Agent Gateway.

To change the Agent Gateway Configuration, you need either:

• The Administrator role, or
• The Manage Agent Gateway permission.

To call Agent Gateway with a Personal Access Token, you need either:

• The Administrator role, or
• The Use Agent Gateway permission.

Configure Agent Gateway

In My Relewise, open the Dataset and go to Administration > Agent Gateway.

Select one or more Connection Methods, then choose the Allowed Areas the Dataset should allow. Agent Gateway is enabled when at least one Connection Method is selected and disabled when none are selected.

Start with the smallest access you need. Enable only the Connection Methods and Allowed Areas required by the connected tool. Core is always enabled and cannot be deselected.

Create a Personal Access Token

In the Personal Access Tokens section on the Agent Gateway page, select Create Token to create a token for the active Dataset. Select Manage All Tokens to view and manage all your tokens. Select Manage Token beside a listed token to open its details and management actions.

Create a token, store the token value immediately, and choose its Dataset Scope:

• No Datasets blocks the token from all Datasets.
• All Datasets allows all current and future Datasets available to your user.
• Selected Datasets allows only the Datasets you select.

The token value is shown once. If you lose it, regenerate the token and update the connected tool.

Authenticate Requests

Agent Gateway uses bearer-token authentication.

Send the token in the Authorization header:

Authorization: Bearer <personal-access-token>

When Agent Gateway is reached through My Relewise, public Agent Gateway routes are available under https://my.relewise.com/agents.

Connect with the REST API

On the Agent Gateway page, select Connection Guide, then open the REST API tab. You can also open the interactive API Reference directly from the REST API Connection Method.

The tab provides:

• AI Tool Instructions that you can copy directly into an AI tool.
• Manual Setup values for configuring a client yourself.
• A link to the interactive API Reference.

Use the OpenAPI specification to discover supported endpoints and request formats. Include the Dataset ID only when the selected endpoint path requires Dataset context.

Dataset-specific REST API routes use this shape:

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

The REST API base URL is:

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

Open the interactive API reference at:

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

The API reference loads the public OpenAPI document from:

https://my.relewise.com/agents/openapi/v1.json

Verify the Personal Access Token

Use the Identity endpoint to verify the Personal Access Token before making Dataset-scoped requests:

GET /api/v1/me

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.

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

The returned Dataset references are candidates for Dataset-scoped access. Use the Core Dataset details endpoint to verify a selected Dataset and retrieve its effective Agent Gateway access settings before making other Dataset-scoped requests.

Connect an MCP Client

MCP lets an AI assistant discover and call Agent Gateway tools through the Model Context Protocol.

On the Agent Gateway page, select Connection Guide, then open the MCP tab. Copy the AI Tool Instructions directly into the AI tool, or use the Manual Setup values to configure the connection yourself.

Every Agent Gateway MCP connection is bound to exactly one Dataset. The Dataset ID is therefore always part of the endpoint:

For MCP clients, the public route shape is:

https://my.relewise.com/agents/{Dataset ID}/mcp

Configure the MCP client to use the full My Relewise URL and send the Personal Access Token in the Authorization HTTP header using the bearer-token format shown above.

Use a distinct connection name for each Dataset. The suggested name shown in My Relewise includes the Dataset ID so multiple Agent Gateway connections remain easy to identify.

MCP tools are discovered by the client after it connects. You do not add a tool name to the URL.

Check Request Logs

If a request does not work as expected, select Request Logs in the Personal Access Tokens section on the Agent Gateway page. The logs show allowed and blocked requests with outcomes and failure reasons.