pub struct AgentStudioService { /* private fields */ }agent-studio only.Expand description
Typed access to the agent-studio API v2 surface (11 operations). Obtained via
Ghl::agent_studio.
Implementations§
Source§impl AgentStudioService
impl AgentStudioService
Sourcepub async fn list_agents(
&self,
params: &ListAgentsParams,
) -> Result<GetPublishedAgentsResponseDTO>
pub async fn list_agents( &self, params: &ListAgentsParams, ) -> Result<GetPublishedAgentsResponseDTO>
List Agents
Lists all active agents for the specified location. locationId is required parameter to ensure optimal performance. Supports pagination using limit and offset. Optionally filter by isPublished=true to return only agents with a published production version.
GET /agent-studio/agent
Requires scope: agent-studio.readonly.
Sourcepub async fn create_agent(
&self,
params: &CreateAgentParams,
body: &CreatePublicAgentDTO,
) -> Result<CreatePublicAgentResponseDTO>
pub async fn create_agent( &self, params: &CreateAgentParams, body: &CreatePublicAgentDTO, ) -> Result<CreatePublicAgentResponseDTO>
Create Agent
Creates a new agent with staging version. The agent will be created with an initial staging version that can later be promoted to production.
POST /agent-studio/agent
Requires scope: agent-studio.write.
Sourcepub async fn update_agent(
&self,
version_id: &str,
params: &UpdateAgentParams,
body: &UpdatePublicAgentVersionDTO,
) -> Result<UpdatePublicAgentResponseDTO>
pub async fn update_agent( &self, version_id: &str, params: &UpdateAgentParams, body: &UpdatePublicAgentVersionDTO, ) -> Result<UpdatePublicAgentResponseDTO>
Update Agent
Updates a specific agent version by versionId. Supports updating nodes, edges, variables, and configuration.
PATCH /agent-studio/agent/versions/{versionId}
Requires scope: agent-studio.write.
Sourcepub async fn promote_to_production(
&self,
version_id: &str,
params: &PromoteToProductionParams,
body: &PromoteAndPublishDTO,
) -> Result<PromoteAndPublishResponseDTO>
pub async fn promote_to_production( &self, version_id: &str, params: &PromoteToProductionParams, body: &PromoteAndPublishDTO, ) -> Result<PromoteAndPublishResponseDTO>
Promote to Production
Promotes a draft version to production.
POST /agent-studio/agent/versions/{versionId}/publish
Requires scope: agent-studio.write.
Sourcepub async fn delete_agent(
&self,
agent_id: &str,
params: &DeleteAgentParams,
) -> Result<DeletePublicAgentResponseDTO>
pub async fn delete_agent( &self, agent_id: &str, params: &DeleteAgentParams, ) -> Result<DeletePublicAgentResponseDTO>
Delete Agent
Deletes an agent and all its versions.
DELETE /agent-studio/agent/{agentId}
Requires scope: agent-studio.write.
Sourcepub async fn get_agent(
&self,
agent_id: &str,
params: &GetAgentParams,
) -> Result<GetAgentByIdResponseDTO>
pub async fn get_agent( &self, agent_id: &str, params: &GetAgentParams, ) -> Result<GetAgentByIdResponseDTO>
Get Agent
Gets a specific agent by its ID for the specified location with all its versions. Returns complete agent metadata and all non-deleted versions (draft, staging, production). locationId is required parameter. The agent must have active status.
GET /agent-studio/agent/{agentId}
Requires scope: agent-studio.readonly.
Sourcepub async fn update_agent_metadata(
&self,
agent_id: &str,
params: &UpdateAgentMetadataParams,
body: &UpdatePublicAgentMetadataDTO,
) -> Result<UpdatePublicAgentResponseDTO>
pub async fn update_agent_metadata( &self, agent_id: &str, params: &UpdateAgentMetadataParams, body: &UpdatePublicAgentMetadataDTO, ) -> Result<UpdatePublicAgentResponseDTO>
Update Agent Metadata
Updates agent metadata such as name, description, and status.
PATCH /agent-studio/agent/{agentId}
Requires scope: agent-studio.write.
Sourcepub async fn execute_agent(
&self,
agent_id: &str,
params: &ExecuteAgentParams,
body: &ExecutePublicAgentDTO,
) -> Result<ExecutePublicAgentResponseDTO>
pub async fn execute_agent( &self, agent_id: &str, params: &ExecuteAgentParams, body: &ExecutePublicAgentDTO, ) -> Result<ExecutePublicAgentResponseDTO>
Execute Agent
Executes the specified agent and returns a non-streaming JSON response with the
complete agent output. The agent must be in active status and belong to the
specified location. locationId is required in the request body. Session
Management: - For the first message in a new session, do not include the
executionId in the request payload. - The API will return an executionId along
with the agent response, which uniquely identifies this conversation session. - To
continue the conversation within the same session, include the executionId from
the previous response in subsequent requests. T
POST /agent-studio/agent/{agentId}/execute
Requires scope: agent-studio.write.
Sourcepub async fn list_agents_deprecated(
&self,
params: &ListAgentsDeprecatedParams,
) -> Result<GetPublishedAgentsResponseDTO>
pub async fn list_agents_deprecated( &self, params: &ListAgentsDeprecatedParams, ) -> Result<GetPublishedAgentsResponseDTO>
List Agents (Deprecated)
Deprecated endpoint - use GET /agent instead. Lists all active agents that have a published production version for the specified location. locationId is required parameter. Supports pagination using limit and offset.
GET /agent-studio/public-api/agents
Requires scope: agent-studio.readonly.
Sourcepub async fn get_agent_deprecated(
&self,
agent_id: &str,
params: &GetAgentDeprecatedParams,
) -> Result<GetAgentByIdResponseDTO>
pub async fn get_agent_deprecated( &self, agent_id: &str, params: &GetAgentDeprecatedParams, ) -> Result<GetAgentByIdResponseDTO>
Get Agent (Deprecated)
Deprecated endpoint - use GET /agent/:agentId instead. Gets a specific agent by its ID for the specified location with all its versions. locationId is required parameter. The agent must have active status.
GET /agent-studio/public-api/agents/{agentId}
Requires scope: agent-studio.readonly.
Sourcepub async fn execute_agent_deprecated(
&self,
agent_id: &str,
params: &ExecuteAgentDeprecatedParams,
body: &ExecutePublicAgentDTO,
) -> Result<ExecutePublicAgentResponseDTO>
pub async fn execute_agent_deprecated( &self, agent_id: &str, params: &ExecuteAgentDeprecatedParams, body: &ExecutePublicAgentDTO, ) -> Result<ExecutePublicAgentResponseDTO>
Execute Agent (Deprecated)
Deprecated endpoint - use POST /agent/:agentId/execute instead. Executes the
specified agent and returns a non-streaming JSON response with the complete agent
output. The agent must be in active status and belong to the specified location.
locationId is required in the request body. Session Management: - For the first
message in a new session, do not include the executionId in the request payload. -
The API will return an executionId along with the agent response, which uniquely
identifies this conversation session. - To continue the conversation within the same
session, include th
POST /agent-studio/public-api/agents/{agentId}/execute
Requires scope: agent-studio.write.
Trait Implementations§
Source§impl Clone for AgentStudioService
impl Clone for AgentStudioService
Source§fn clone(&self) -> AgentStudioService
fn clone(&self) -> AgentStudioService
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more