Atlassian: Agents schemas
6 Atlassian schemas with complete fields and constraints.
← Agents operations · All 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) — 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
| 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) — 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 |
Bulk start agent sessions (uniform) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Start one agent across multiple issues with a shared optional prompt. Additional keys: not allowed |
agentId | string | Required within parent | Rovo agent ID. |
clientMutationId | string | Required within parent | Caller-supplied UUID. Format: uuid |
issueIds | array | Required within parent | Between 1 and 50 numeric issue-ID strings. IDs must be unique. |
issueIds[] | string | Each item | Between 1 and 50 numeric issue-ID strings. IDs must be unique. |
userPrompt | JSON | Optional | |
userPrompt (anyOf 1) | string | Alternative | Optional prompt applied to every issue. |
userPrompt (anyOf 2) | null | Alternative |