Agents

List an agent's schemas

Changed on

Return agent's input and output schemas. You can use these schemas to detect changes to an agent's input or output structure.

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

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/agents/{agent_id}/schemas
  • 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

The name of the agent.

input_schemaobject required

The schema for the agent input. In JSON Schema format.

output_schemaobject required

The schema for the agent output. In JSON Schema format.

Example response

{
  "agent_id": "mho4lwzylcozgoc2",
  "name": "HR Policy Agent"
}

Changes