Atlassian: Bulk start agent sessions (batch)
Atlassian agents.startBatch: arguments, response, policy and SDK examples.
← Agents operations · Get started
Operation atlassian.startbatch
Provider route: POST /{cloudId}/rest/api/3/agents/bulk/invoke/batch. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AtlassianIntegration } from "@alter-ai/atlassian";
async function execute(input: Parameters<AtlassianIntegration["agents"]["startBatch"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.agents.startBatch(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_atlassian import AtlassianIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.agents.start_batch(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.cloudId | string | Required within parent | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
body | Model | Required within parent | Expand Bulk start agent sessions (batch) — request body — body |
Referenced models: Bulk start agent sessions (batch) — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Bulk start agent sessions (batch) — response body |
Referenced models: Bulk start agent sessions (batch) — response body
Schemas
Section titled “Schemas”Bulk start agent sessions (batch) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A batch of agent-session invocations. Additional keys: not allowed |
clientMutationId | string | Required within parent | Caller-supplied UUID Format: uuid |
invocations | array | Required within parent | Between 1 and 50 invocations. Request IDs must be unique within the request. |
invocations[] | Model | Each item | Expand Bulk start agent sessions (batch) — request body — body invocations item |
Referenced models: Bulk start agent sessions (batch) — request body — body invocations item
Bulk start agent sessions (batch) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Session-start outcomes, not completion of the agent's work. |
alreadyStartedCount | JSON | Optional | |
alreadyStartedCount (anyOf 1) | JSON | Alternative | |
alreadyStartedCount (anyOf 1) (anyOf 1) | integer | Alternative | Number of ALREADY\_STARTED items. Format: int32 Minimum: 0 |
alreadyStartedCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
alreadyStartedCount (anyOf 2) | null | Alternative | |
failedCount | JSON | Optional | |
failedCount (anyOf 1) | JSON | Alternative | |
failedCount (anyOf 1) (anyOf 1) | integer | Alternative | Number of FAILED and IN\_DOUBT items. Format: int32 Minimum: 0 |
failedCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
failedCount (anyOf 2) | null | Alternative | |
rateLimitedCount | JSON | Optional | |
rateLimitedCount (anyOf 1) | JSON | Alternative | |
rateLimitedCount (anyOf 1) (anyOf 1) | integer | Alternative | Number of RATE\_LIMITED items. Format: int32 Minimum: 0 |
rateLimitedCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rateLimitedCount (anyOf 2) | null | Alternative | |
results | JSON | Optional | |
results (anyOf 1) | array | Alternative | One outcome per requested item. |
results (anyOf 1)[] | Model | Each item | Expand Bulk start agent sessions (batch) — response body — results One outcome per requested item item |
results (anyOf 2) | null | Alternative | |
startedCount | JSON | Optional | |
startedCount (anyOf 1) | JSON | Alternative | |
startedCount (anyOf 1) (anyOf 1) | integer | Alternative | Number of STARTED items. Format: int32 Minimum: 0 |
startedCount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startedCount (anyOf 2) | null | Alternative | |
success | JSON | Optional | |
success (anyOf 1) | boolean | Alternative | True when startedCount or alreadyStartedCount is greater than zero. Does not indicate that every item succeeded. |
success (anyOf 2) | null | Alternative |
Referenced models: Bulk start agent sessions (batch) — response body — results One outcome per requested item item
Bulk start agent sessions (batch) — request body — body invocations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | One agent-session invocation for an issue. Additional keys: not allowed |
agentId | string | Required within parent | Rovo agent ID. |
issueId | string | Required within parent | Numeric issue ID as a string. |
requestId | string | Required within parent | Unique per-item UUID. Format: uuid |
userPrompt | JSON | Optional | |
userPrompt (anyOf 1) | string | Alternative | Optional prompt for this invocation. |
userPrompt (anyOf 2) | null | Alternative |
Bulk start agent sessions (batch) — response body — results One outcome per requested item item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The start outcome for one invocation. |
agentId | JSON | Optional | |
agentId (anyOf 1) | string | Alternative | The caller's Rovo agent ID. |
agentId (anyOf 2) | null | Alternative | |
conversationId | JSON | Optional | |
conversationId (anyOf 1) | JSON | Alternative | |
conversationId (anyOf 1) (anyOf 1) | string | Alternative | Conversation ID for STARTED or ALREADY\_STARTED only. |
conversationId (anyOf 1) (anyOf 2) | null | Alternative | |
conversationId (anyOf 2) | null | Alternative | |
error | JSON | Optional | |
error (anyOf 1) | Model | Alternative | Expand Bulk start agent sessions (batch) — response body — results One outcome per requested item item error value |
error (anyOf 2) | null | Alternative | |
issueId | JSON | Optional | |
issueId (anyOf 1) | string | Alternative | Numeric issue ID. |
issueId (anyOf 2) | null | Alternative | |
requestId | JSON | Optional | |
requestId (anyOf 1) | string | Alternative | The per-item requestId for batch; the shared clientMutationId for uniform. |
requestId (anyOf 2) | null | Alternative | |
result | JSON | Optional | |
result (anyOf 1) | string | Alternative | STARTED: session started; ALREADY\_STARTED: recorded successful retry; FAILED: invocation failed; RATE\_LIMITED: admission denied; IN\_DOUBT: start could not be confirmed. Known values: STARTED, ALREADY_STARTED, FAILED, RATE_LIMITED, IN_DOUBT |
result (anyOf 2) | null | Alternative |
Referenced models: Bulk start agent sessions (batch) — response body — results One outcome per requested item item error value
Bulk start agent sessions (batch) — response body — results One outcome per requested item item error value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | An item-level error inside an HTTP 200 response. |
$ (anyOf 1).message | JSON | Optional | |
$ (anyOf 1).message (anyOf 1) | string | Alternative | Error message. |
$ (anyOf 1).message (anyOf 2) | null | Alternative | |
$ (anyOf 1).statusCode | JSON | Optional | |
$ (anyOf 1).statusCode (anyOf 1) | JSON | Alternative | |
$ (anyOf 1).statusCode (anyOf 1) (anyOf 1) | integer | Alternative | HTTP status code. Format: int32 |
$ (anyOf 1).statusCode (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).statusCode (anyOf 2) | null | Alternative | |
$ (anyOf 1).type | JSON | Optional | |
$ (anyOf 1).type (anyOf 1) | string | Alternative | Error type. Known values: AGENT_NOT_ASSIGNABLE, AGENT_NOT_FOUND, INVALID_REQUEST_ID, ISSUE_NOT_FOUND, IDEMPOTENCY_CONFLICT, ISSUE_VERSION_MISSING, ISSUE_ACCESS_DENIED, RATE_LIMITED, CONCURRENCY_SATURATED, AGENT_TRIGGER_FAILED, IDEMPOTENCY_ERROR, PRIOR_ATTEMPT_FAILED, SESSION_NOT_STARTED, IN_DOUBT, UNEXPECTED_ERROR |
$ (anyOf 1).type (anyOf 2) | null | Alternative | |
$ (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: atlassian.startbatch. Catalog operation: startbatch. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["write:jira-work"]