Skip to content

README.md

Latest commit

 

History

History
62 lines (42 loc) · 9.11 KB

README.md

File metadata and controls

62 lines (42 loc) · 9.11 KB
Raw

Admin.Agents

Overview

Available Operations

  • list - List all agents

list

List every agent in the workspace, ordered by name and then by agent_id. Each agent has the same shape that Get agent returns. Unlike agent search, the list does not depend on who an agent is shared with, so it includes private and disabled agents. Deleted agents are left out. Use the agent_id with other Platform APIs, for example as a usage limit target. The caller must be able to read all agents, administer agents, or read workspace billing.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.errors.PlatformProblemDetailException;
import com.glean.api_client.glean_api_client.models.operations.PlatformAdminAgentsListResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws PlatformProblemDetailException, Exception {

        Glean sdk = Glean.builder()
                .apiToken(System.getenv().getOrDefault("GLEAN_API_TOKEN", ""))
            .build();

        PlatformAdminAgentsListResponse res = sdk.admin().agents().list()
                .pageSize(50L)
                .call();

        if (res.platformListAdminAgentsResponse().isPresent()) {
            System.out.println(res.platformListAdminAgentsResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description
pageSize Optional<Long> ➖ Maximum number of agents to return. Defaults to 50. Maximum is 100.
cursor Optional<String> ➖ Opaque pagination cursor from a previous response. Send the same filters that the previous request used.
filters List<PlatformAdminAgentFilter> ➖ JSON-encoded filters that choose which agents are returned. The supported fields are name and description, with the operator EQUALS. Multiple values OR within a filter. Multiple filters AND together, and each field can appear in only one filter. For example, to return agents whose name contains "HR", send [{"field":"name","values":["HR"]}].

Response

PlatformAdminAgentsListResponse

Errors

Error Type Status Code Content Type
models/errors/PlatformProblemDetailException 400, 401, 403, 404, 408, 429 application/problem+json
models/errors/PlatformProblemDetailException 500, 503 application/problem+json
models/errors/APIException 4XX, 5XX */*