storage:provider
storage:provider
Section titled “storage:provider”| Field | Value |
|---|---|
| Prefix | storage:provider |
| Namespace constant | ProviderStorageNamespace |
| Subjects constant | ProviderStorageSubjects |
| Kind | storage |
| Schema record | <inline> |
| Tier | framework |
| Package | @makaio/services-core |
| Defined in | packages/services/core/src/settings/storage/providers-namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
get | storage:provider.get | rpc | — |
list | storage:provider.list | rpc | — |
listByProtocol | storage:provider.listByProtocol | rpc | — |
Subject Details
Section titled “Subject Details”storage:provider.get (rpc)
Section titled “storage:provider.get (rpc)”Subject: storage:provider.get
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
id | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
provider | { id: string; packageName: string; name: string; availableModels: { name: string; contextWindowSize: number; labId: string; friendlyName?: string | undefined; family?: string | undefined; supportedReasoningLevels?: { none?: string | number | undefined; low?: string | number | undefined; medium?: string | number | undefined; high?: string | number | undefined; 'extra-high'?: string | number | undefined; } | undefined; metadata?: { maxOutputTokens?: number | undefined; capabilities?: { vision?: boolean | undefined; toolCalling?: boolean | undefined; parallelToolCalls?: boolean | undefined; structuredOutput?: boolean | undefined; pdfUpload?: boolean | undefined; speechToText?: { modes: ("batch" | "streaming")[]; vocabularyBiasing?: boolean | undefined; } | undefined; textToSpeech?: { modes: ("streaming" | "buffered")[]; voiceSelection?: boolean | undefined; voiceInstructions?: boolean | undefined; outputFormats?: string[] | undefined; } | undefined; } | undefined; pricing?: { token?: { inputPerMillion: number; outputPerMillion: number; inputCachedPerMillion?: number | undefined; cacheWritePerMillion?: number | undefined; } | undefined; request?: { multiplier: number; } | undefined; } | undefined; includedInSubscription?: boolean | undefined; description?: string | undefined; } | undefined; }[]; defaultModelFilterMode: "allowlist" | "show-all"; enabled: boolean; createdAt: number; updatedAt: number; description?: string | undefined; endpoints?: { anthropic?: string | undefined; openai?: string | undefined; } | undefined; defaultModel?: string | undefined; fastModel?: string | undefined; credentialEnvVars?: Record<string, string> | undefined; } | null | yes |
storage:provider.list (rpc)
Section titled “storage:provider.list (rpc)”Subject: storage:provider.list
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
providers | { id: string; packageName: string; name: string; availableModels: { name: string; contextWindowSize: number; labId: string; friendlyName?: string | undefined; family?: string | undefined; supportedReasoningLevels?: { none?: string | number | undefined; low?: string | number | undefined; medium?: string | number | undefined; high?: string | number | undefined; 'extra-high'?: string | number | undefined; } | undefined; metadata?: { maxOutputTokens?: number | undefined; capabilities?: { vision?: boolean | undefined; toolCalling?: boolean | undefined; parallelToolCalls?: boolean | undefined; structuredOutput?: boolean | undefined; pdfUpload?: boolean | undefined; speechToText?: { modes: ("batch" | "streaming")[]; vocabularyBiasing?: boolean | undefined; } | undefined; textToSpeech?: { modes: ("streaming" | "buffered")[]; voiceSelection?: boolean | undefined; voiceInstructions?: boolean | undefined; outputFormats?: string[] | undefined; } | undefined; } | undefined; pricing?: { token?: { inputPerMillion: number; outputPerMillion: number; inputCachedPerMillion?: number | undefined; cacheWritePerMillion?: number | undefined; } | undefined; request?: { multiplier: number; } | undefined; } | undefined; includedInSubscription?: boolean | undefined; description?: string | undefined; } | undefined; }[]; defaultModelFilterMode: "allowlist" | "show-all"; enabled: boolean; createdAt: number; updatedAt: number; description?: string | undefined; endpoints?: { anthropic?: string | undefined; openai?: string | undefined; } | undefined; defaultModel?: string | undefined; fastModel?: string | undefined; credentialEnvVars?: Record<string, string> | undefined; }[] | yes |
storage:provider.listByProtocol (rpc)
Section titled “storage:provider.listByProtocol (rpc)”Subject: storage:provider.listByProtocol
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
protocol | "anthropic" | "openai" | yes |
Response:
| Field | Type | Required |
|---|---|---|
providers | { id: string; packageName: string; name: string; availableModels: { name: string; contextWindowSize: number; labId: string; friendlyName?: string | undefined; family?: string | undefined; supportedReasoningLevels?: { none?: string | number | undefined; low?: string | number | undefined; medium?: string | number | undefined; high?: string | number | undefined; 'extra-high'?: string | number | undefined; } | undefined; metadata?: { maxOutputTokens?: number | undefined; capabilities?: { vision?: boolean | undefined; toolCalling?: boolean | undefined; parallelToolCalls?: boolean | undefined; structuredOutput?: boolean | undefined; pdfUpload?: boolean | undefined; speechToText?: { modes: ("batch" | "streaming")[]; vocabularyBiasing?: boolean | undefined; } | undefined; textToSpeech?: { modes: ("streaming" | "buffered")[]; voiceSelection?: boolean | undefined; voiceInstructions?: boolean | undefined; outputFormats?: string[] | undefined; } | undefined; } | undefined; pricing?: { token?: { inputPerMillion: number; outputPerMillion: number; inputCachedPerMillion?: number | undefined; cacheWritePerMillion?: number | undefined; } | undefined; request?: { multiplier: number; } | undefined; } | undefined; includedInSubscription?: boolean | undefined; description?: string | undefined; } | undefined; }[]; defaultModelFilterMode: "allowlist" | "show-all"; enabled: boolean; createdAt: number; updatedAt: number; description?: string | undefined; endpoints?: { anthropic?: string | undefined; openai?: string | undefined; } | undefined; defaultModel?: string | undefined; fastModel?: string | undefined; credentialEnvVars?: Record<string, string> | undefined; }[] | yes |
Auto-generated by yarn docs:bus. Do not edit manually.