1. Home
  2. Documentation
  3. AI Gateway
  4. AI Agents

AI Agents

Register AI agents with OAuth credentials and authorization scopes.

The AI Agents module registers the AI agents that consume AI Gateway. Each AI Agent has a unique identifier, a free-form description, a list of Scopes that defines what the agent can access, and a pair of Client ID / Client Secret credentials managed by the gateway. Agents use these credentials to get access tokens client_credentials and call the Routes and MCP Servers whose scopes match the agent's scopes.

NOTE

Before creating your AI Agent, register at least one Scope. The form requires at least one scope to be selected and does not let you save with an empty list.

Learn how to:

Listing

The AI Agents page lists registered agents with pagination. You can filter by:

  • Name (optional): text search by agent name.
  • Description (optional): text search by description.

Use Search to apply the filter and Clear to reset it.

Columns shown in the table:

  • Name: agent name.
  • Description: registered free-form description.
  • Scopes: list of associated scopes, resolved to the name registered in Scopes. Shows No scopes assigned. when empty.
  • Created At: creation date and time in your time zone.
  • Actions: Edit and Delete icons for each row.

Create AI Agent

Step 1

On the AI Agents page, click Create AI Agent.

Step 2

Fill in Name and Description, and select at least one Scope (see Form fields). The Scopes field is a multi-select populated by the Scopes catalog.

Step 3

Click Save to confirm the registration. To discard the operation, click Cancel.

TIP

The Credentials section does not appear in the creation form. Credentials are generated and managed in the edit form (see below).

Edit AI Agent

In the Actions column of the row you want, click the Edit icon. The Update AI Agent form opens with the current data and shows the Credentials section below the editable fields, as described in Manage credentials. Change the required fields and click Save.

Manage credentials

The Credentials section appears only in the edit form and shows:

  • Status: Active or Status: Revoked: current state of the agent credentials.
  • Client ID: masked by default. Use the eye icon to reveal it and the copy icon to copy it.
  • Client Secret: follows the same behavior as Client ID.
  • Action buttons that change according to the status:
Current status
Primary button
Effect
Secondary button
ActiveRotateReplaces the current Client ID / Client Secret pair with a new pair. The old pair becomes invalid immediately.Revoke
RevokedGenerateGenerates a new Client ID / Client Secret pair and changes the status to Active.Revoke (disabled)
ROTATION AND REVOCATION ARE IMMEDIATE

Rotate and Revoke invalidate the previous pair in the same operation. Agents that were using the old pair start failing until you update them. Coordinate the operation with the production agent update.

When the status is Revoked, the Client ID and Client Secret fields are empty, the visibility toggles are disabled, and the Revoke button is disabled. Use Generate to issue a new pair.

Delete AI Agent

In the Actions column of the row you want, click the Delete icon. Confirm the operation in the "Do you want to delete AI agent [agentId]?" dialog.

IMPORTANT

Deletion is permanent and cannot be undone. Credentials associated with the agent are invalidated, and any integration still using the Client ID / Client Secret pair starts failing.

Form fields

The table below covers all editable fields in the creation and edit forms. The Credentials section is managed separately (see Manage credentials).

Field
Type
Required
Rules
NameTextYesMinimum 1 character.
DescriptionLong text (textarea)YesMinimum 1 character.
ScopesMulti-selectYes, at least oneList populated by the Scopes catalog. The stored value is a list of scope IDs.

How happy are you with this page?

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more