Agents

Overview

Available Operations

search - Search agents
get - Get agent
getSchemas - Get agent schemas
createRun - Create agent run
getRun - Get agent run
cancelRun - Cancel an agent run
respondToRun - Respond to agent run approvals

search

Search agents available to the authenticated user by agent name.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.PlatformAgentsSearchRequest;
import com.glean.api_client.glean_api_client.models.errors.PlatformProblemDetailException;
import com.glean.api_client.glean_api_client.models.operations.PlatformAgentsSearchResponse;
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();

        PlatformAgentsSearchRequest req = PlatformAgentsSearchRequest.builder()
                .name("HR Policy Agent")
                .build();

        PlatformAgentsSearchResponse res = sdk.agents().search()
                .request(req)
                .call();

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

Parameters

Parameter	Type	Required	Description
`request`	PlatformAgentsSearchRequest	✔️	The request object to use for the request.

Response

PlatformAgentsSearchResponse

Errors

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

get

Retrieve details for an agent available to the authenticated user.

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.PlatformAgentsGetResponse;
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();

        PlatformAgentsGetResponse res = sdk.agents().get()
                .agentId("{agent_id}")
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`agentId`	String	✔️	ID of the agent to retrieve.	{agent_id}

Response

PlatformAgentsGetResponse

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	/

getSchemas

Retrieve an agent's input and output JSON schemas.

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.PlatformAgentsGetSchemasResponse;
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();

        PlatformAgentsGetSchemasResponse res = sdk.agents().getSchemas()
                .agentId("{agent_id}")
                .includeTools(false)
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`agentId`	String	✔️	ID of the agent whose schemas should be retrieved.	{agent_id}
`includeTools`	Optional<Boolean>	➖	Whether to include tool metadata in the response.

Response

PlatformAgentsGetSchemasResponse

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	/

createRun

Execute an agent run. By default, set stream to true to receive server-sent events; otherwise the response contains the final agent messages. Set execution_mode to DURABLE to persist a new run and return its initial snapshot with HTTP 201 without waiting for execution. Poll the agent-scoped GET run endpoint for progress. Durable execution continues after an HTTP disconnect, but is not automatically resumed after a QE restart or crash. An active turn becomes overdue more than 40 minutes after acceptance (a 30-minute execution timeout plus 10 minutes of grace). The next GET of the run marks the overdue turn FAILED without replay; there is no periodic sweep. Without a GET, the stored run can remain RUNNING. Failure does not prove that external tool work has stopped. Paused runs are not expired; an accepted approval continuation starts a fresh deadline. Each POST creates a new run; retrying a POST can create another execution. Submit pending approval decisions through the run responses endpoint, and cancellation can be requested through the run cancellations endpoint. A run tracks one workflow execution; automatic background-subagent wake turns are separate executions, not continuations tracked by this run ID.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.*;
import com.glean.api_client.glean_api_client.models.errors.PlatformProblemDetailException;
import com.glean.api_client.glean_api_client.models.errors.PlatformUnauthorizedAgentToolsProblemException;
import com.glean.api_client.glean_api_client.models.operations.PlatformAgentsCreateRunResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

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

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

        PlatformAgentsCreateRunResponse res = sdk.agents().createRun()
                .agentId("{agent_id}")
                .platformAgentRunCreateRequest(PlatformAgentRunCreateRequest.builder()
                    .messages(List.of(
                        PlatformMessageInput.builder()
                            .role(PlatformMessageRole.USER)
                            .content(List.of(
                                PlatformMessageTextBlockInput.builder()
                                    .text("What is our parental leave policy?")
                                    .type(PlatformContentType.TEXT)
                                    .build()))
                            .build()))
                    .build())
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`agentId`	String	✔️	ID of the agent to run.	{agent_id}
`platformAgentRunCreateRequest`	PlatformAgentRunCreateRequest	✔️	N/A	{ "messages": [ { "role": "USER", "content": [ { "text": "What is our parental leave policy?", "type": "text" } ] } ] }

Response

PlatformAgentsCreateRunResponse

Errors

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

getRun

Retrieve a persisted workflow execution owned by the authenticated user. The run must belong to the specified agent, and the user must still have access to that agent. Unknown runs, runs owned by another user, and mismatched agent/run identifiers return 404. Requires the agents.run scope. Executions without a persisted workflow record are not available through this endpoint.

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.PlatformAgentsGetRunResponse;
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();

        PlatformAgentsGetRunResponse res = sdk.agents().getRun()
                .agentId("{agent_id}")
                .runId("{run_id}")
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`agentId`	String	✔️	ID of the agent that owns the run.	{agent_id}
`runId`	String	✔️	ID of the durable run to retrieve.	{run_id}

Response

PlatformAgentsGetRunResponse

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	/

cancelRun

Request cooperative cancellation of the durable agent run identified by run_id in the JSON body. Requires ownership, current agent access, and the agents.run scope. Sending a cancellation signal does not itself change an active run from RUNNING; poll GET run for the final state. Paused runs become CANCELLED without resuming execution. Repeated requests and requests for terminal runs return the current snapshot. Completion may win a race with cancellation. Completed tool side effects cannot be undone, and external work may continue if a tool does not support cancellation. Cancellation targets this run, not separate background-subagent executions. An active run without a cancellation registration returns 409. Cancellation signaling requires Redis. An interrupted active run can instead become FAILED through deadline cleanup; this does not verify that external tool work has stopped.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.PlatformAgentRunCancellationRequest;
import com.glean.api_client.glean_api_client.models.errors.PlatformProblemDetailException;
import com.glean.api_client.glean_api_client.models.operations.PlatformAgentsCancelRunResponse;
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();

        PlatformAgentsCancelRunResponse res = sdk.agents().cancelRun()
                .agentId("{agent_id}")
                .platformAgentRunCancellationRequest(PlatformAgentRunCancellationRequest.builder()
                    .runId("{run_id}")
                    .build())
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`agentId`	String	✔️	ID of the agent that owns the run.	{agent_id}
`platformAgentRunCancellationRequest`	PlatformAgentRunCancellationRequest	✔️	N/A	{ "run_id": "{run_id}" }

Response

PlatformAgentsCancelRunResponse

Errors

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

respondToRun

Submit decisions for every pending tool approval in the paused run's current batch. The run is identified by run_id in the JSON body. Decisions apply only to the stored invocations and arguments; argument edits, authentication responses, and session-wide grants are not supported. The caller must own the run, still have agent access, and have the agents.run scope. Acceptance persists the decisions before resuming the same run and chat session. Identical accepted decisions return the current snapshot without another continuation. Conflicting, stale, incomplete, or non-pending decisions return 409. Cancellation registration failure returns 503 without accepting the decisions; retry the same approval batch. This retry guarantee does not cover an indeterminate database commit outcome. Go workflow approval resumes currently support one tool invocation and one approval response. Unsupported multi-tool or multi-decision Go resumes fail without executing tools. The resumed action must resolve to the tool identified by the stored approval request and paused checkpoint. Missing or inconsistent identity fails without executing tools. Execution continues after HTTP disconnects, but is not automatically resumed after a QE crash. Each accepted continuation starts a fresh 30-minute execution timeout and 40-minute cleanup deadline. Identical retries do not extend that deadline. Waiting for approval does not expire a run. The next GET marks an overdue active turn FAILED without replaying execution.

Example Usage

package hello.world;

import com.glean.api_client.glean_api_client.Glean;
import com.glean.api_client.glean_api_client.models.components.*;
import com.glean.api_client.glean_api_client.models.errors.PlatformProblemDetailException;
import com.glean.api_client.glean_api_client.models.operations.PlatformAgentsCreateRunResponsesResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

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

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

        PlatformAgentsCreateRunResponsesResponse res = sdk.agents().respondToRun()
                .agentId("{agent_id}")
                .platformAgentRunResponsesRequest(PlatformAgentRunResponsesRequest.builder()
                    .runId("{run_id}")
                    .responses(List.of(
                        PlatformAgentRunApprovalDecision.builder()
                            .interactionId("{interaction_id}")
                            .decision(Decision.APPROVE)
                            .build()))
                    .build())
                .call();

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

Parameters

Parameter	Type	Required	Description	Example
`agentId`	String	✔️	ID of the agent that owns the run.	{agent_id}
`platformAgentRunResponsesRequest`	PlatformAgentRunResponsesRequest	✔️	N/A	{ "run_id": "{run_id}", "responses": [ { "interaction_id": "{interaction_id}", "decision": "APPROVE" } ] }

Response

PlatformAgentsCreateRunResponsesResponse

Errors

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

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Agents

Overview

Available Operations

search

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

getSchemas

Example Usage

Parameters

Response

Errors

createRun

Example Usage

Parameters

Response

Errors

getRun

Example Usage

Parameters

Response

Errors

cancelRun

Example Usage

Parameters

Response

Errors

respondToRun

Example Usage

Parameters

Response

Errors