Skip to main content

AgentChatCompletionCreate

Request body for POST /agent/{id}/chat/completions. Mirrors OpenAI's Chat Completions create request. Most generation params are accepted for SDK compatibility but ignored (the agent runs with its workflow-bound model/tools).

messages object[]required

OpenAI chat messages. The last user-role message supplies the prompt.

Possible values: >= 1

  • Array [
  • rolestringrequired
    content

    String or multi-modal content array (flattened to text parts).

    namestring
    tool_call_idstring
    tool_calls
  • ]
  • modelstring

    Accepted; the agent's workflow binding selects the real model.

    streamboolean
    Default value: false
    stream_options object
    include_usageboolean
    ninteger

    Must be 1 when present; multi-choice is unsupported.

    Possible values: [1]

    temperaturenumber

    Accepted but ignored.

    top_pnumber

    Accepted but ignored.

    max_tokensinteger

    Accepted but ignored.

    Possible values: >= 1

    max_completion_tokensinteger

    Accepted but ignored.

    Possible values: >= 1

    seednumber

    Accepted but ignored.

    presence_penaltynumber

    Accepted but ignored.

    frequency_penaltynumber

    Accepted but ignored.

    logit_bias

    Accepted but ignored.

    userstring

    Accepted but ignored.

    stop

    Accepted but ignored.

    tools

    Accepted but ignored — the agent's bound tool set is defined in its workflow.

    tool_choice

    Accepted but ignored.

    parallel_tool_callsboolean

    Accepted but ignored.

    response_format

    Accepted but ignored.

    conversation_idstring

    Alien-platform extension: the session id carried between turns for multi-turn continuity.

    extra_fields object

    Alien-platform extension: caller-supplied fields merged into the workflow input node alongside user_prompt/session_id/model. Reserved-key collisions are rejected with HTTP 400.

    property name*any

    Alien-platform extension: caller-supplied fields merged into the workflow input node alongside user_prompt/session_id/model. Reserved-key collisions are rejected with HTTP 400.

    AgentChatCompletionCreate
    {
    "messages": [
    {
    "role": "string",
    "name": "string",
    "tool_call_id": "string",
    "tool_calls": {}
    }
    ],
    "model": "string",
    "stream": false,
    "stream_options": {
    "include_usage": true
    },
    "n": 1,
    "temperature": 0,
    "top_p": 0,
    "max_tokens": 0,
    "max_completion_tokens": 0,
    "seed": 0,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "user": "string",
    "parallel_tool_calls": true,
    "conversation_id": "string",
    "extra_fields": {}
    }