chat

Chat

Changed on
post/v1/agent_sessions/{session_id}/chat

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

session_idstring required

Request body

headlessboolean required

Whether a headless client (terminal or scripted) is driving the turn, as opposed to the browser assistant. Selects the agent configuration the turn runs on.

editPermission'manual' | 'bypass'
requestedSkillsstring[]

Skills the user explicitly requested via the prompt's slash-command affordance. The server force-loads each available skill by injecting a synthetic load_skill tool call/result at the tail of the message history. Unknown or context-unavailable names are ignored.

trigger'submit-message'
idstring required
lastMessageIdstring nullable

The id of the last transcript message the client has rendered, used for optimistic concurrency. Omit when the session has no messages; required (and validated against the persisted transcript) once it does. On mismatch the server rejects the send with HTTP 409 and code agent_session_messages_stale — the client should refetch the session before retrying.

recordLocalTracesboolean
exportRemoteTracesboolean
instrumentUserIdboolean

When true and the request is authenticated as a PhoenixUser, attaches the user's email as the OpenInference user.id span attribute on all traced work for this request.

Response

Successful Response

unknown required

Changes

  • ff6e981135a8Revision changes
    • breaking

      removed from the /// request property anyOf list

    • info

      added to the /// request property anyOf list

  • 21f0faa20fccRevision changes
    • info

      added the new META enum value to the request property //