Launch agent
agents_launchLaunch an Omnara agent from a pinned config or profile, optionally attaching integration tools, subscriptions, interaction handlers, and an initial text input atomically.
Instructions
Launch from a pinned config, optionally adding agent-local integration tools, subscriptions and interaction handlers and admitting an attributed initial text input in the same transaction. Adding integration capabilities requires project management permission; launching an existing config requires agent operate permission. Reusing an idempotency key returns the current agent even if the retry body differs. The retry body is not applied and integration references are not resolved again.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Agent name. Empty means the agent is unnamed; non-empty values use the ResourceName policy. | |
| orgID | Yes | ||
| tools | No | Additional integration tool entries (int__<integration-name>__<operation>) and optional list_interaction_handlers or set_interaction_handler tools for this agent. Other tool names are not accepted here. Existing config entries win unchanged. Requires project management permission. The derived config is created atomically with the agent and initial input; the profile is unchanged. | |
| config | No | ||
| message | No | Optional initial text message. Mutually exclusive with initial_input. | |
| profile | No | ||
| projectID | Yes | ||
| config_source | No | An agent config to compile. YAML sources are stored verbatim, so comments and formatting survive; JSON sources, as text or as an object, are stored canonicalized, so the same JSON definition always maps to the same config. | |
| initial_input | No | Initial queued text input, committed atomically with the agent and any derived config. Mutually exclusive with message. Initial inline media is not supported; upload it through the agent input endpoint after launch. | |
| subscriptions | No | Integration-owned conversation subscriptions attached atomically with launch and initial input. Requires project management permission. Subscriptions alone preserve the pinned config. Launch replay never adds or restores subscriptions. | |
| interaction_handlers | No | Additional integration interaction handlers, keyed by immutable integration name with empty object values. Slack and Discord handlers require an assigned conversation and accept empty runtime args. Adding a handler does not assign a conversation. Existing entries win unchanged. Requires project management permission. |