Skip to main content
Unary · Agents Sends user input to an active agent run. This method is used to provide interactive or conversation-based input to an agent. The agent can respond with output blocks containing text, file changes, or tool usage requests.

Examples

  • Send a text message to an agent:

Endpoint

Send a Bearer token as described in Authentication. If your organization uses a custom management-plane domain, replace https://app.ona.com with that domain.

Request example

Request

gitpod.v1.SendToAgentExecutionRequest

Response

gitpod.v1.SendToAgentExecutionResponse This message has no fields.
gitpod.v1.AgentControlInput
gitpod.v1.AgentControlInput.CompactThis message has no fields.
gitpod.v1.AgentControlInput.DeleteQueuedMessage
gitpod.v1.AgentControlInput.Goal
gitpod.v1.AgentControlInput.MoveQueuedMessage
gitpod.v1.AgentControlInput.SteerQueuedMessage
AgentMessage is a message sent between agents (e.g. from a parent agent to a child agent execution, or vice versa).gitpod.v1.AgentMessage
CodexSettings contains settings consumed only by the Codex app agent.gitpod.v1.CodexSettings
gitpod.v1.TurnOptions
gitpod.v1.UserInputBlock
ImageInput allows sending images to the agent. Client must provide the MIME type; backend validates against magic bytes.gitpod.v1.UserInputBlock.ImageInput
gitpod.v1.UserInputBlock.Input
gitpod.v1.UserInputBlock.TextInput
UserInputMetadata carries integration-specific context for a user input. Internal only - not exposed in public SDKs. External API consumers should not set these fields; they are populated by integration handlers.gitpod.v1.UserInputMetadata
WakeEvent is sent by the backend to wake an agent when a registered interest fires. Delivered via SendToAgentExecution as a new oneof variant.gitpod.v1.WakeEvent
gitpod.v1.WakeEvent.DevcontainerPhaseReached
gitpod.v1.WakeEvent.EnvironmentPhaseReached
gitpod.v1.WakeEvent.LoopRetrigger
gitpod.v1.WakeEvent.TimerFired
Role identifies the sender’s relationship in the parent/child hierarchy.
AgentMode defines the operational mode of an agent
CodexOpenAIModel is the static allowlist of concrete OpenAI models that the Codex app runtime can select through Ona’s Codex picker.
CodexReasoningEffort is the static allowlist of reasoning efforts supported by the Codex app runtime.
CodexServiceTier is the static allowlist of service tiers supported by the Codex app runtime.