Skip to main content

Discussions Commands

See Discussions module docs for permissions and data model.

soat list-discussions​

List discussions

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

Usage​

soat list-discussions

Options​

--project-id​

Project ID (optional)

  • Source: query
  • Required: no
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--limit​

Maximum number of results to return

  • Source: query
  • Required: no
  • Type: integer
  • Default: 50
--offset​

Number of results to skip

  • Source: query
  • Required: no
  • Type: integer
  • Default: 0

soat create-discussion​

Create a discussion

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

Usage​

soat create-discussion --name <string> --ai-provider-id <string>

Options​

--project-id​

Project ID. Required for JWT auth; omit when using a project key.

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

—

  • Source: body
  • Required: yes
  • Type: string
  • Example: Design review panel
--description​

—

  • Source: body
  • Required: no
  • Type: string \| null
--ai-provider-id​

Default AI provider participants and synthesis fall back to.

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

Default model (falls back to the provider's default_model).

  • Source: body
  • Required: no
  • Type: string \| null
--max-rounds​

—

  • Source: body
  • Required: no
  • Type: integer
  • Default: 1
--synthesis​

Override for the final synthesis pass that weighs the deliberation into a single outcome.

  • Source: body
  • Required: no
  • Type: object
--tags​

—

  • Source: body
  • Required: no
  • Type: object<string, string>
--participants​

—

  • Source: body
  • Required: no
  • Type: array<object>

soat get-discussion-run​

Get a discussion run by ID

  • Method: GET
  • Path: /api/v1/discussions/runs/{run_id}

Usage​

soat get-discussion-run --run-id <string>

Options​

--run-id​

Discussion run ID

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

soat get-discussion​

Get a discussion by ID

  • Method: GET
  • Path: /api/v1/discussions/{discussion_id}

Usage​

soat get-discussion --discussion-id <string>

Options​

--discussion-id​

Discussion ID

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

soat update-discussion​

Update a discussion

  • Method: PATCH
  • Path: /api/v1/discussions/{discussion_id}

Usage​

soat update-discussion --discussion-id <string>

Options​

--discussion-id​

Discussion ID

  • Source: path
  • Required: yes
  • Type: string
  • Example: disc_V1StGXR8Z5jdHi6B
--name​

—

  • Source: body
  • Required: no
  • Type: string
--description​

—

  • Source: body
  • Required: no
  • Type: string \| null
--ai-provider-id​

—

  • Source: body
  • Required: no
  • Type: string
--model​

—

  • Source: body
  • Required: no
  • Type: string \| null
--max-rounds​

—

  • Source: body
  • Required: no
  • Type: integer
--synthesis​

Override for the final synthesis pass that weighs the deliberation into a single outcome.

  • Source: body
  • Required: no
  • Type: object
--tags​

—

  • Source: body
  • Required: no
  • Type: object<string, string>
--participants​

—

  • Source: body
  • Required: no
  • Type: array<object>

soat delete-discussion​

Delete a discussion

  • Method: DELETE
  • Path: /api/v1/discussions/{discussion_id}

Usage​

soat delete-discussion --discussion-id <string>

Options​

--discussion-id​

Discussion ID

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

soat create-discussion-run​

Invoke a discussion

  • Method: POST
  • Path: /api/v1/discussions/{discussion_id}/runs

Usage​

soat create-discussion-run --discussion-id <string> --topic <string>

Options​

--discussion-id​

Discussion ID

  • Source: path
  • Required: yes
  • Type: string
  • Example: disc_V1StGXR8Z5jdHi6B
--topic​

The question or subject the participants deliberate on.

  • Source: body
  • Required: yes
  • Type: string
  • Example: Should we migrate the queue to Kafka?

soat list-discussion-runs​

List a discussion's runs

  • Method: GET
  • Path: /api/v1/discussions/{discussion_id}/runs

Usage​

soat list-discussion-runs --discussion-id <string>

Options​

--discussion-id​

Discussion ID

  • Source: path
  • Required: yes
  • Type: string
  • Example: disc_V1StGXR8Z5jdHi6B
--limit​

—

  • Source: query
  • Required: no
  • Type: integer
  • Default: 50
--offset​

—

  • Source: query
  • Required: no
  • Type: integer
  • Default: 0