Skip to main content

AI Providers

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

soat.aiProviders.listAiProviders()​

List AI providers

  • Method: GET
  • Path: /api/v1/ai-providers
await soat.aiProviders.listAiProviders({
  query: { /* + optional */ },
});

→ Request & response schema

soat.aiProviders.createAiProvider()​

Create an AI provider

  • Method: POST
  • Path: /api/v1/ai-providers
await soat.aiProviders.createAiProvider({
  body: { name, provider, default_model, /* + optional */ },
});

→ Request & response schema

soat.aiProviders.getAiProvider()​

Get an AI provider

  • Method: GET
  • Path: /api/v1/ai-providers/{ai_provider_id}
await soat.aiProviders.getAiProvider({
  path: { ai_provider_id },
});

→ Request & response schema

soat.aiProviders.updateAiProvider()​

Update an AI provider

  • Method: PATCH
  • Path: /api/v1/ai-providers/{ai_provider_id}
await soat.aiProviders.updateAiProvider({
  path: { ai_provider_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.aiProviders.deleteAiProvider()​

Delete an AI provider

  • Method: DELETE
  • Path: /api/v1/ai-providers/{ai_provider_id}
await soat.aiProviders.deleteAiProvider({
  path: { ai_provider_id },
  query: { /* + optional */ },
});

→ Request & response schema

soat.aiProviders.getAiProviderPrices()​

List per-provider price overrides

  • Method: GET
  • Path: /api/v1/ai-providers/{ai_provider_id}/prices
await soat.aiProviders.getAiProviderPrices({
  path: { ai_provider_id },
});

→ Request & response schema

soat.aiProviders.updateAiProviderPrices()​

Upsert per-provider price overrides

  • Method: PUT
  • Path: /api/v1/ai-providers/{ai_provider_id}/prices
await soat.aiProviders.updateAiProviderPrices({
  path: { ai_provider_id },
  body: { prices },
});

→ Request & response schema