DeleteAgentExecution

agents.delete_execution() -> object

POST/gitpod.v1.AgentService/DeleteAgentExecution

Deletes an agent run.

Use this method to:

Clean up agent runs that are no longer needed

Examples

Delete an agent run by ID:

agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35"

ParametersExpand Collapse

agent_execution_id: Optional[str]

formatuuid

ReturnsExpand Collapse

object

DeleteAgentExecution

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.agents.delete_execution(
    agent_execution_id="6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35",
)
print(response)

{}

Returns Examples

{}