Agents

Retrieve an agent

Changed on

Returns details of an agent created in the Agent Builder.

get/rest/api/v1/agents/{agent_id}

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/agents/{agent_id}
  • Auth: HTTP bearer

Path parameters

agent_idstring required

The ID of the agent.

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

timezoneOffsetinteger

The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.

Response

Success

agent_idstring required

The ID of the agent.

namestring required

The name of the agent

descriptionstring

The description of the agent.

metadataobject

The agent metadata. Currently not implemented.

Example response

{
  "agent_id": "mho4lwzylcozgoc2",
  "name": "HR Policy Agent",
  "description": "This agent answers questions about the current company HR policies."
}

Changes