Skip to main content

Discussions

SDK methods for the Discussions module, accessed via soat.discussions. See the Discussions module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.discussions.listDiscussions()​

List discussions

  • Method: GET
  • Path: /api/v1/discussions
await soat.discussions.listDiscussions({
  query: { /* + optional */ },
});

→ Request & response schema

soat.discussions.createDiscussion()​

Create a discussion

  • Method: POST
  • Path: /api/v1/discussions
await soat.discussions.createDiscussion({
  body: { name, ai_provider_id, /* + optional */ },
});

→ Request & response schema

soat.discussions.getDiscussionRun()​

Get a discussion run by ID

  • Method: GET
  • Path: /api/v1/discussions/runs/{run_id}
await soat.discussions.getDiscussionRun({
  path: { run_id },
});

→ Request & response schema

soat.discussions.getDiscussion()​

Get a discussion by ID

  • Method: GET
  • Path: /api/v1/discussions/{discussion_id}
await soat.discussions.getDiscussion({
  path: { discussion_id },
});

→ Request & response schema

soat.discussions.updateDiscussion()​

Update a discussion

  • Method: PATCH
  • Path: /api/v1/discussions/{discussion_id}
await soat.discussions.updateDiscussion({
  path: { discussion_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.discussions.deleteDiscussion()​

Delete a discussion

  • Method: DELETE
  • Path: /api/v1/discussions/{discussion_id}
await soat.discussions.deleteDiscussion({
  path: { discussion_id },
});

→ Request & response schema

soat.discussions.createDiscussionRun()​

Invoke a discussion

  • Method: POST
  • Path: /api/v1/discussions/{discussion_id}/runs
await soat.discussions.createDiscussionRun({
  path: { discussion_id },
  body: { topic },
});

→ Request & response schema

soat.discussions.listDiscussionRuns()​

List a discussion's runs

  • Method: GET
  • Path: /api/v1/discussions/{discussion_id}/runs
await soat.discussions.listDiscussionRuns({
  path: { discussion_id },
  query: { /* + optional */ },
});

→ Request & response schema