Skip to main content

Agent

Agent

id

The ID of this Agent.

workspace_id

The ID of the workspace hosting this Agent.

name

The name of this Agent.

objective

A short description of this Agent’s objective, e.g. “Extract key information from leases and addendum documents”.

created

When this Agent was created, formatted as an ISO 8601 timestamp (e.g. 2025-12-31T10:15:45+00:00)

updated

When this Agent was last updated, formatted as an ISO 8601 timestamp (e.g. 2025-12-31T10:15:45+00:00)

created_by

The email address of the user who created this Agent.

agent_guidelines

n_runs

The number of times this Agent has been Run.

prompts

The Prompts configured for this Agent.

output_templates

The Templates configured for this Agent, used to generate formatted output documents.

metadata

Metadata for this Agent.

ListAgentsResponse

ListAgentsResponse

agents

The page of fetched Agents.

total_pages

The total number of pages of Agents. Use the request arguments page_number and page_size to control which Agents are fetched.

page_number

The number of the fetched page.

page_size

The page size, i.e. number of Agents, fetched.

CopyAgentRequest

CopyAgentRequest

name

Name of the agent to be created by copying the source agent.

target_workspace_id

target_folder_id

UpdateAgentRequest

UpdateAgentRequest

metadata

ListWorkspacesResponse

ListWorkspacesResponse

workspaces

List of accessible workspaces. Callers with organization-scoped View Usage, Manage Usage, or View Access Logs permissions receive all workspaces in the organization.