Skip to main content

Chats Commands

See Chats module docs for permissions and data model.

soat create-chat​

Create a chat

  • Method: POST
  • Path: /api/v1/chats

Usage​

soat create-chat --ai-provider-id <string>

Options​

--ai-provider-id​

Public ID of the AI provider

  • Source: body
  • Required: yes
  • Type: string
  • Example: aip_V1StGXR8Z5jdHi6B
--project-id​

Public ID of the project. Required when the user belongs to multiple projects and no project key is used.

  • Source: body
  • Required: no
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--name​

Optional human-readable name

  • Source: body
  • Required: no
  • Type: string
  • Example: Support Bot
--system-message​

Optional system message applied to all completions on this chat

  • Source: body
  • Required: no
  • Type: string
  • Example: You are a helpful support assistant.
--model​

Optional default model override

  • Source: body
  • Required: no
  • Type: string
  • Example: gpt-4o

soat list-chats​

List chats

  • Method: GET
  • Path: /api/v1/chats

Usage​

soat list-chats

Options​

--project-id​

Project public ID to filter by

  • Source: query
  • Required: no
  • Type: string

soat get-chat​

Get a chat

  • Method: GET
  • Path: /api/v1/chats/{chat_id}

Usage​

soat get-chat --chat-id <string>

Options​

--chat-id​

—

  • Source: path
  • Required: yes
  • Type: string

soat delete-chat​

Delete a chat

  • Method: DELETE
  • Path: /api/v1/chats/{chat_id}

Usage​

soat delete-chat --chat-id <string>

Options​

--chat-id​

—

  • Source: path
  • Required: yes
  • Type: string

soat create-chat-completion-for-chat​

Create a chat completion for a stored chat

  • Method: POST
  • Path: /api/v1/chats/{chat_id}/completions

Usage​

soat create-chat-completion-for-chat --chat-id <string> --messages <array<object>>

Options​

--chat-id​

—

  • Source: path
  • Required: yes
  • Type: string
--messages​

—

  • Source: body
  • Required: yes
  • Type: array<object>
--model​

Override the chat's default model for this call

  • Source: body
  • Required: no
  • Type: string
  • Example: gpt-4o-mini
--stream​

When true the response is an SSE stream.

  • Source: body
  • Required: no
  • Type: boolean
  • Default: false

soat create-chat-completion​

Create a chat completion (stateless)

  • Method: POST
  • Path: /api/v1/chat/completions

Usage​

soat create-chat-completion --ai-provider-id <string> --messages <array<object>>

Options​

--ai-provider-id​

Public ID of the AI provider to use.

  • Source: body
  • Required: yes
  • Type: string
  • Example: aip_V1StGXR8Z5jdHi6B
--model​

Model identifier. Overrides the provider's default_model when specified.

  • Source: body
  • Required: no
  • Type: string
  • Example: gpt-4o
--messages​

Ordered list of chat messages

  • Source: body
  • Required: yes
  • Type: array<object>
--stream​

When true the response is an SSE stream of delta chunks. When false (default) a single JSON object is returned.

  • Source: body
  • Required: no
  • Type: boolean
  • Default: false