CreateAgentExecutionConversationToken

agents.create_execution_conversation_token() -> AgentCreateExecutionConversationTokenResponse

POST/gitpod.v1.AgentService/CreateAgentExecutionConversationToken

Creates a token for conversation access with a specific agent run.

This method generates a temporary token that can be used to securely connect to an ongoing agent conversation, for example in a web UI.

Examples

Create a token to join an agent run conversation in a front-end application:
```
agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35"
```

ParametersExpand Collapse

agent_execution_id: Optional[str]

formatuuid

ReturnsExpand Collapse

class AgentCreateExecutionConversationTokenResponse: …

token: Optional[str]

CreateAgentExecutionConversationToken

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.create_execution_conversation_token(
    agent_execution_id="6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35",
)
print(response.token)

{
  "token": "token"
}

Returns Examples

{
  "token": "token"
}