Skip to main content

AgentResponseCreate

Request body for POST /agent/{id}/responses. Mirrors OpenAI's Responses create request with Alien-platform scoping. instructions, tools, and tool_choice are accepted for SDK compatibility; sampling params (temperature, top_p, max_output_tokens, parallel_tool_calls) are accepted but dropped (the agent runs with its workflow-bound model/tools).

modelstringrequired

Required. Surfaced on Response.model. LDS passes the literal "agent" (the agent's workflow binding selects the real model).

Possible values: non-empty

input objectrequired

Required. Either a plain user-prompt string, or an array of structured input items.

oneOf
string
instructions object

Optional system/developer instructions. Accepted and forwarded.

oneOf
string
previous_response_idstring

The id of a prior response, for multi-turn linkage. The platform resolves it to the underlying agent session.

streamboolean

When true, the response is streamed as text/event-stream. When false/absent, the full response is returned as one JSON object.

Default value: false
toolsobject[]

Advisory only — the agent runs with its workflow-bound tool set.

tool_choice

Advisory only; accepted but not enforced.

temperaturenumber

Accepted but dropped.

top_pnumber

Accepted but dropped.

max_output_tokensinteger

Accepted but dropped.

Possible values: >= 1

parallel_tool_callsboolean

Accepted but dropped.

includestring[]

Response include flags; accepted but currently dropped.

metadata object

Free-form caller metadata (≤16 keys, ≤64-char keys, ≤512-char values), forwarded onto Response.metadata. The x_alien_* key prefix is reserved by the platform; colliding caller keys are stripped.

property name*string
backgroundboolean

Background mode is NOT supported. Present-and-true is rejected with HTTP 400.

Possible values: [false]

conversation

NOT supported in v1 — rejected with HTTP 400. Use previous_response_id for multi-turn linkage.

extra_fields object

Alien-platform extension: caller-supplied fields merged into the workflow's input node alongside the platform-controlled user_prompt/session_id/model. Keys colliding with the platform-controlled set are rejected with HTTP 400.

property name*any

Alien-platform extension: caller-supplied fields merged into the workflow's input node alongside the platform-controlled user_prompt/session_id/model. Keys colliding with the platform-controlled set are rejected with HTTP 400.

AgentResponseCreate
{
"model": "string",
"input": "string",
"instructions": "string",
"previous_response_id": "string",
"stream": false,
"tools": [
{}
],
"temperature": 0,
"top_p": 0,
"max_output_tokens": 0,
"parallel_tool_calls": true,
"include": [
"string"
],
"metadata": {},
"background": false,
"extra_fields": {}
}