agent

Create agent run

Create an asynchronous agent run and start execution in the background.

Use `inputHistoryMode=delta_v1` to send only `newUserMessage` and let the server reconstruct a bounded rolling context. A continuation supplies the thread's authoritative `current_run_id` as `baseRunId`.

Required scope: `inference:run`

post/agent/runs

Headers

Idempotency-Keystring

Retry key scoped to the authenticated tenant and principal. Required and non-blank for every delta_v1 request; optional for legacy_full.

Request body

Example request

{
  "input": {
    "redactionPolicyId": "pii-standard"
  }
}

Response

Agent run accepted

run_idstring required
thread_idstring required
workflow_typestring required
provider'ANTHROPIC_DIRECT' | 'BEDROCK' | 'OPENAI' | 'VERTEX_AI' required
execution_mode'LOCAL' | 'AGENTCORE' required
status'QUEUED' | 'RUNNING' | 'CANCELLING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED' required

Agent run lifecycle state.

runtime_arnstring nullable
mcp_session_idstring nullable
trace_idstring nullable

保存済みW3C trace contextから導出したlowercase OpenTelemetry trace ID。移行前の行はnull。

idempotency_keystring nullable
created_atstring date-time nullable
started_atstring date-time nullable
finished_atstring date-time nullable
inputobject nullable

Server-enriched agent input used to reconstruct the thread transcript.

parent_run_idstring nullable

Run this run branched from within the thread (null for the thread root).

input_history_mode'legacy_full' | 'delta_v1' required

How the request supplied conversation history for this run.

context_start_run_idstring nullable required

Oldest run included in the reconstructed rolling context, or null when none was needed.

context_truncatedboolean required

Whether older turns were omitted to stay within the server context budget.

resultobject nullable
errorobject nullable

Example response

{
  "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}

Changes

Changed in 11 of the 71 revisions of this API.115

    • added the new optional request property /

      new-optional-request-property

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the new optional request property ///

      new-optional-request-property

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the new optional request property //

      new-optional-request-property

    • added the new optional request property //

      new-optional-request-property

    • added the new optional request property //

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new optional request property ///

      new-optional-request-property

    • added the new VERTEX_AI enum value to the response property for the response status

      response-property-enum-value-added

    • added the new optional request property ///

      new-optional-request-property

    • added the new datetime enum value to the request property //////

      request-property-enum-value-added

    • added the new datetime enum value to the request property //////

      request-property-enum-value-added

Of the 71 revisions, 18 have no diff computed.