api.md

Shared

Types:

• Action
• ActionLink
• APILinks
• APIMeta
• BackwardLinks
• ChatCompletionChunk
• ChatCompletionTokenLogprob
• CompletionUsage
• DiskInfo
• Droplet
• DropletNextBackupWindow
• FirewallRuleTarget
• ForwardLinks
• GarbageCollection
• GPUInfo
• Image
• ImageGenCompletedEvent
• ImageGenPartialImageEvent
• ImageGenStreamEvent
• Kernel
• MetaProperties
• NetworkV4
• NetworkV6
• PageLinks
• Region
• Size
• Snapshots
• Subscription
• SubscriptionTierBase
• VpcPeering

Agents

Types:

• APIAgent
• APIAgentAPIKeyInfo
• APIAgentModel
• APIAnthropicAPIKeyInfo
• APIDeploymentVisibility
• APIOpenAIAPIKeyInfo
• APIRetrievalMethod
• APIWorkspace
• AgentCreateResponse
• AgentRetrieveResponse
• AgentUpdateResponse
• AgentListResponse
• AgentDeleteResponse
• AgentRetrieveUsageResponse
• AgentUpdateStatusResponse

Methods:

• client.agents.create({ ...params }) -> AgentCreateResponse
• client.agents.retrieve(uuid) -> AgentRetrieveResponse
• client.agents.update(pathUuid, { ...params }) -> AgentUpdateResponse
• client.agents.list({ ...params }) -> AgentListResponse
• client.agents.delete(uuid) -> AgentDeleteResponse
• client.agents.retrieveUsage(uuid, { ...params }) -> AgentRetrieveUsageResponse
• client.agents.updateStatus(pathUuid, { ...params }) -> AgentUpdateStatusResponse

APIKeys

Types:

• APIKeyCreateResponse
• APIKeyUpdateResponse
• APIKeyListResponse
• APIKeyDeleteResponse
• APIKeyRegenerateResponse

Methods:

• client.agents.apiKeys.create(agentUuid, { ...params }) -> APIKeyCreateResponse
• client.agents.apiKeys.update(apiKeyUuid, { ...params }) -> APIKeyUpdateResponse
• client.agents.apiKeys.list(agentUuid, { ...params }) -> APIKeyListResponse
• client.agents.apiKeys.delete(apiKeyUuid, { ...params }) -> APIKeyDeleteResponse
• client.agents.apiKeys.regenerate(apiKeyUuid, { ...params }) -> APIKeyRegenerateResponse

Chat

Completions

Types:

• CompletionCreateResponse

Methods:

• client.agents.chat.completions.create({ ...params }) -> CompletionCreateResponse

EvaluationMetrics

Types:

• EvaluationMetricListResponse
• EvaluationMetricListRegionsResponse

Methods:

• client.agents.evaluationMetrics.list() -> EvaluationMetricListResponse
• client.agents.evaluationMetrics.listRegions({ ...params }) -> EvaluationMetricListRegionsResponse

Workspaces

Types:

• WorkspaceCreateResponse
• WorkspaceRetrieveResponse
• WorkspaceUpdateResponse
• WorkspaceListResponse
• WorkspaceDeleteResponse
• WorkspaceListEvaluationTestCasesResponse

Methods:

• client.agents.evaluationMetrics.workspaces.create({ ...params }) -> WorkspaceCreateResponse
• client.agents.evaluationMetrics.workspaces.retrieve(workspaceUuid) -> WorkspaceRetrieveResponse
• client.agents.evaluationMetrics.workspaces.update(workspaceUuid, { ...params }) -> WorkspaceUpdateResponse
• client.agents.evaluationMetrics.workspaces.list() -> WorkspaceListResponse
• client.agents.evaluationMetrics.workspaces.delete(workspaceUuid) -> WorkspaceDeleteResponse
• client.agents.evaluationMetrics.workspaces.listEvaluationTestCases(workspaceUuid) -> WorkspaceListEvaluationTestCasesResponse

Agents

Types:

• AgentListResponse
• AgentMoveResponse

Methods:

• client.agents.evaluationMetrics.workspaces.agents.list(workspaceUuid, { ...params }) -> AgentListResponse
• client.agents.evaluationMetrics.workspaces.agents.move(workspaceUuid, { ...params }) -> AgentMoveResponse

Models

Types:

• ModelListResponse

Methods:

• client.agents.evaluationMetrics.models.list({ ...params }) -> ModelListResponse

Anthropic

Keys

Types:

• KeyCreateResponse
• KeyRetrieveResponse
• KeyUpdateResponse
• KeyListResponse
• KeyDeleteResponse
• KeyListAgentsResponse

Methods:

• client.agents.evaluationMetrics.anthropic.keys.create({ ...params }) -> KeyCreateResponse
• client.agents.evaluationMetrics.anthropic.keys.retrieve(apiKeyUuid) -> KeyRetrieveResponse
• client.agents.evaluationMetrics.anthropic.keys.update(apiKeyUuid, { ...params }) -> KeyUpdateResponse
• client.agents.evaluationMetrics.anthropic.keys.list({ ...params }) -> KeyListResponse
• client.agents.evaluationMetrics.anthropic.keys.delete(apiKeyUuid) -> KeyDeleteResponse
• client.agents.evaluationMetrics.anthropic.keys.listAgents(uuid, { ...params }) -> KeyListAgentsResponse

OpenAI

Keys

Types:

• KeyCreateResponse
• KeyRetrieveResponse
• KeyUpdateResponse
• KeyListResponse
• KeyDeleteResponse
• KeyListAgentsResponse

Methods:

• client.agents.evaluationMetrics.openai.keys.create({ ...params }) -> KeyCreateResponse
• client.agents.evaluationMetrics.openai.keys.retrieve(apiKeyUuid) -> KeyRetrieveResponse
• client.agents.evaluationMetrics.openai.keys.update(apiKeyUuid, { ...params }) -> KeyUpdateResponse
• client.agents.evaluationMetrics.openai.keys.list({ ...params }) -> KeyListResponse
• client.agents.evaluationMetrics.openai.keys.delete(apiKeyUuid) -> KeyDeleteResponse
• client.agents.evaluationMetrics.openai.keys.listAgents(uuid, { ...params }) -> KeyListAgentsResponse

Oauth2

Types:

• Oauth2GenerateURLResponse

Methods:

• client.agents.evaluationMetrics.oauth2.generateURL({ ...params }) -> Oauth2GenerateURLResponse

Dropbox

Types:

• DropboxCreateTokensResponse

Methods:

• client.agents.evaluationMetrics.oauth2.dropbox.createTokens({ ...params }) -> DropboxCreateTokensResponse

EvaluationRuns

Types:

• APIEvaluationMetric
• APIEvaluationMetricResult
• APIEvaluationPrompt
• APIEvaluationRun
• EvaluationRunCreateResponse
• EvaluationRunRetrieveResponse
• EvaluationRunListResultsResponse
• EvaluationRunRetrieveResultsResponse

Methods:

• client.agents.evaluationRuns.create({ ...params }) -> EvaluationRunCreateResponse
• client.agents.evaluationRuns.retrieve(evaluationRunUuid) -> EvaluationRunRetrieveResponse
• client.agents.evaluationRuns.listResults(evaluationRunUuid, { ...params }) -> EvaluationRunListResultsResponse
• client.agents.evaluationRuns.retrieveResults(promptID, { ...params }) -> EvaluationRunRetrieveResultsResponse

EvaluationTestCases

Types:

• APIEvaluationTestCase
• APIStarMetric
• EvaluationTestCaseCreateResponse
• EvaluationTestCaseRetrieveResponse
• EvaluationTestCaseUpdateResponse
• EvaluationTestCaseListResponse
• EvaluationTestCaseListEvaluationRunsResponse

Methods:

• client.agents.evaluationTestCases.create({ ...params }) -> EvaluationTestCaseCreateResponse
• client.agents.evaluationTestCases.retrieve(testCaseUuid, { ...params }) -> EvaluationTestCaseRetrieveResponse
• client.agents.evaluationTestCases.update(testCaseUuid, { ...params }) -> EvaluationTestCaseUpdateResponse
• client.agents.evaluationTestCases.list() -> EvaluationTestCaseListResponse
• client.agents.evaluationTestCases.listEvaluationRuns(evaluationTestCaseUuid, { ...params }) -> EvaluationTestCaseListEvaluationRunsResponse

EvaluationDatasets

Types:

• EvaluationDatasetCreateResponse
• EvaluationDatasetCreateFileUploadPresignedURLsResponse

Methods:

• client.agents.evaluationDatasets.create({ ...params }) -> EvaluationDatasetCreateResponse
• client.agents.evaluationDatasets.createFileUploadPresignedURLs({ ...params }) -> EvaluationDatasetCreateFileUploadPresignedURLsResponse

Functions

Types:

• FunctionCreateResponse
• FunctionUpdateResponse
• FunctionDeleteResponse

Methods:

• client.agents.functions.create(agentUuid, { ...params }) -> FunctionCreateResponse
• client.agents.functions.update(functionUuid, { ...params }) -> FunctionUpdateResponse
• client.agents.functions.delete(functionUuid, { ...params }) -> FunctionDeleteResponse

Versions

Types:

• VersionUpdateResponse
• VersionListResponse

Methods:

• client.agents.versions.update(pathUuid, { ...params }) -> VersionUpdateResponse
• client.agents.versions.list(uuid, { ...params }) -> VersionListResponse

KnowledgeBases

Types:

• APILinkKnowledgeBaseOutput
• KnowledgeBaseDetachResponse

Methods:

• client.agents.knowledgeBases.attach(agentUuid) -> APILinkKnowledgeBaseOutput
• client.agents.knowledgeBases.attachSingle(knowledgeBaseUuid, { ...params }) -> APILinkKnowledgeBaseOutput
• client.agents.knowledgeBases.detach(knowledgeBaseUuid, { ...params }) -> KnowledgeBaseDetachResponse

Routes

Types:

• RouteUpdateResponse
• RouteDeleteResponse
• RouteAddResponse
• RouteViewResponse

Methods:

• client.agents.routes.update(childAgentUuid, { ...params }) -> RouteUpdateResponse
• client.agents.routes.delete(childAgentUuid, { ...params }) -> RouteDeleteResponse
• client.agents.routes.add(childAgentUuid, { ...params }) -> RouteAddResponse
• client.agents.routes.view(uuid) -> RouteViewResponse

Chat

Completions

Types:

• CompletionCreateResponse

Methods:

• client.chat.completions.create({ ...params }) -> CompletionCreateResponse

Images

Types:

• ImageGenerateResponse

Methods:

• client.images.generate({ ...params }) -> ImageGenerateResponse

GPUDroplets

Types:

• DropletBackupPolicy
• GPUDropletCreateResponse
• GPUDropletRetrieveResponse
• GPUDropletListResponse
• GPUDropletListFirewallsResponse
• GPUDropletListKernelsResponse
• GPUDropletListNeighborsResponse
• GPUDropletListSnapshotsResponse

Methods:

• client.gpuDroplets.create({ ...params }) -> GPUDropletCreateResponse
• client.gpuDroplets.retrieve(dropletID) -> GPUDropletRetrieveResponse
• client.gpuDroplets.list({ ...params }) -> GPUDropletListResponse
• client.gpuDroplets.delete(dropletID) -> void
• client.gpuDroplets.deleteByTag({ ...params }) -> void
• client.gpuDroplets.listFirewalls(dropletID, { ...params }) -> GPUDropletListFirewallsResponse
• client.gpuDroplets.listKernels(dropletID, { ...params }) -> GPUDropletListKernelsResponse
• client.gpuDroplets.listNeighbors(dropletID) -> GPUDropletListNeighborsResponse
• client.gpuDroplets.listSnapshots(dropletID, { ...params }) -> GPUDropletListSnapshotsResponse

Backups

Types:

• BackupListResponse
• BackupListPoliciesResponse
• BackupListSupportedPoliciesResponse
• BackupRetrievePolicyResponse

Methods:

• client.gpuDroplets.backups.list(dropletID, { ...params }) -> BackupListResponse
• client.gpuDroplets.backups.listPolicies({ ...params }) -> BackupListPoliciesResponse
• client.gpuDroplets.backups.listSupportedPolicies() -> BackupListSupportedPoliciesResponse
• client.gpuDroplets.backups.retrievePolicy(dropletID) -> BackupRetrievePolicyResponse

Actions

Types:

• ActionRetrieveResponse
• ActionListResponse
• ActionBulkInitiateResponse
• ActionInitiateResponse

Methods:

• client.gpuDroplets.actions.retrieve(actionID, { ...params }) -> ActionRetrieveResponse
• client.gpuDroplets.actions.list(dropletID, { ...params }) -> ActionListResponse
• client.gpuDroplets.actions.bulkInitiate({ ...params }) -> ActionBulkInitiateResponse
• client.gpuDroplets.actions.initiate(dropletID, { ...params }) -> ActionInitiateResponse

DestroyWithAssociatedResources

Types:

• AssociatedResource
• DestroyedAssociatedResource
• DestroyWithAssociatedResourceListResponse
• DestroyWithAssociatedResourceCheckStatusResponse

Methods:

• client.gpuDroplets.destroyWithAssociatedResources.list(dropletID) -> DestroyWithAssociatedResourceListResponse
• client.gpuDroplets.destroyWithAssociatedResources.checkStatus(dropletID) -> DestroyWithAssociatedResourceCheckStatusResponse
• client.gpuDroplets.destroyWithAssociatedResources.deleteDangerous(dropletID, { ...params }) -> void
• client.gpuDroplets.destroyWithAssociatedResources.deleteSelective(dropletID, { ...params }) -> void
• client.gpuDroplets.destroyWithAssociatedResources.retry(dropletID) -> void

Autoscale

Types:

• AutoscalePool
• AutoscalePoolDropletTemplate
• AutoscalePoolDynamicConfig
• AutoscalePoolStaticConfig
• CurrentUtilization
• AutoscaleCreateResponse
• AutoscaleRetrieveResponse
• AutoscaleUpdateResponse
• AutoscaleListResponse
• AutoscaleListHistoryResponse
• AutoscaleListMembersResponse

Methods:

• client.gpuDroplets.autoscale.create({ ...params }) -> AutoscaleCreateResponse
• client.gpuDroplets.autoscale.retrieve(autoscalePoolID) -> AutoscaleRetrieveResponse
• client.gpuDroplets.autoscale.update(autoscalePoolID, { ...params }) -> AutoscaleUpdateResponse
• client.gpuDroplets.autoscale.list({ ...params }) -> AutoscaleListResponse
• client.gpuDroplets.autoscale.delete(autoscalePoolID) -> void
• client.gpuDroplets.autoscale.deleteDangerous(autoscalePoolID, { ...params }) -> void
• client.gpuDroplets.autoscale.listHistory(autoscalePoolID, { ...params }) -> AutoscaleListHistoryResponse
• client.gpuDroplets.autoscale.listMembers(autoscalePoolID, { ...params }) -> AutoscaleListMembersResponse

Firewalls

Types:

• Firewall
• FirewallCreateResponse
• FirewallRetrieveResponse
• FirewallUpdateResponse
• FirewallListResponse

Methods:

• client.gpuDroplets.firewalls.create({ ...params }) -> FirewallCreateResponse
• client.gpuDroplets.firewalls.retrieve(firewallID) -> FirewallRetrieveResponse
• client.gpuDroplets.firewalls.update(firewallID, { ...params }) -> FirewallUpdateResponse
• client.gpuDroplets.firewalls.list({ ...params }) -> FirewallListResponse
• client.gpuDroplets.firewalls.delete(firewallID) -> void

Droplets

Methods:

• client.gpuDroplets.firewalls.droplets.add(firewallID, { ...params }) -> void
• client.gpuDroplets.firewalls.droplets.remove(firewallID, { ...params }) -> void

Tags

Methods:

• client.gpuDroplets.firewalls.tags.add(firewallID, { ...params }) -> void
• client.gpuDroplets.firewalls.tags.remove(firewallID, { ...params }) -> void

Rules

Methods:

• client.gpuDroplets.firewalls.rules.add(firewallID, { ...params }) -> void
• client.gpuDroplets.firewalls.rules.remove(firewallID, { ...params }) -> void

FloatingIPs

Types:

• FloatingIP
• FloatingIPCreateResponse
• FloatingIPRetrieveResponse
• FloatingIPListResponse

Methods:

• client.gpuDroplets.floatingIPs.create({ ...params }) -> FloatingIPCreateResponse
• client.gpuDroplets.floatingIPs.retrieve(floatingIP) -> FloatingIPRetrieveResponse
• client.gpuDroplets.floatingIPs.list({ ...params }) -> FloatingIPListResponse
• client.gpuDroplets.floatingIPs.delete(floatingIP) -> void

Actions

Types:

• ActionCreateResponse
• ActionRetrieveResponse
• ActionListResponse

Methods:

• client.gpuDroplets.floatingIPs.actions.create(floatingIP, { ...params }) -> ActionCreateResponse
• client.gpuDroplets.floatingIPs.actions.retrieve(actionID, { ...params }) -> ActionRetrieveResponse
• client.gpuDroplets.floatingIPs.actions.list(floatingIP) -> ActionListResponse

Images

Types:

• ImageCreateResponse
• ImageRetrieveResponse
• ImageUpdateResponse
• ImageListResponse

Methods:

• client.gpuDroplets.images.create({ ...params }) -> ImageCreateResponse
• client.gpuDroplets.images.retrieve(imageID) -> ImageRetrieveResponse
• client.gpuDroplets.images.update(imageID, { ...params }) -> ImageUpdateResponse
• client.gpuDroplets.images.list({ ...params }) -> ImageListResponse
• client.gpuDroplets.images.delete(imageID) -> void

Actions

Types:

• ActionListResponse

Methods:

• client.gpuDroplets.images.actions.create(imageID, { ...params }) -> Action
• client.gpuDroplets.images.actions.retrieve(actionID, { ...params }) -> Action
• client.gpuDroplets.images.actions.list(imageID) -> ActionListResponse

LoadBalancers

Types:

• Domains
• ForwardingRule
• GlbSettings
• HealthCheck
• LbFirewall
• LoadBalancer
• StickySessions
• LoadBalancerCreateResponse
• LoadBalancerRetrieveResponse
• LoadBalancerUpdateResponse
• LoadBalancerListResponse

Methods:

• client.gpuDroplets.loadBalancers.create({ ...params }) -> LoadBalancerCreateResponse
• client.gpuDroplets.loadBalancers.retrieve(lbID) -> LoadBalancerRetrieveResponse
• client.gpuDroplets.loadBalancers.update(lbID, { ...params }) -> LoadBalancerUpdateResponse
• client.gpuDroplets.loadBalancers.list({ ...params }) -> LoadBalancerListResponse
• client.gpuDroplets.loadBalancers.delete(lbID) -> void
• client.gpuDroplets.loadBalancers.deleteCache(lbID) -> void

Droplets

Methods:

• client.gpuDroplets.loadBalancers.droplets.add(lbID, { ...params }) -> void
• client.gpuDroplets.loadBalancers.droplets.remove(lbID, { ...params }) -> void

ForwardingRules

Methods:

• client.gpuDroplets.loadBalancers.forwardingRules.add(lbID, { ...params }) -> void
• client.gpuDroplets.loadBalancers.forwardingRules.remove(lbID, { ...params }) -> void

Sizes

Types:

• SizeListResponse

Methods:

• client.gpuDroplets.sizes.list({ ...params }) -> SizeListResponse

Snapshots

Types:

• SnapshotRetrieveResponse
• SnapshotListResponse

Methods:

• client.gpuDroplets.snapshots.retrieve(snapshotID) -> SnapshotRetrieveResponse
• client.gpuDroplets.snapshots.list({ ...params }) -> SnapshotListResponse
• client.gpuDroplets.snapshots.delete(snapshotID) -> void

Volumes

Types:

• VolumeCreateResponse
• VolumeRetrieveResponse
• VolumeListResponse

Methods:

• client.gpuDroplets.volumes.create({ ...params }) -> VolumeCreateResponse
• client.gpuDroplets.volumes.retrieve(volumeID) -> VolumeRetrieveResponse
• client.gpuDroplets.volumes.list({ ...params }) -> VolumeListResponse
• client.gpuDroplets.volumes.delete(volumeID) -> void
• client.gpuDroplets.volumes.deleteByName({ ...params }) -> void

Actions

Types:

• VolumeAction
• ActionRetrieveResponse
• ActionListResponse
• ActionInitiateByIDResponse
• ActionInitiateByNameResponse

Methods:

• client.gpuDroplets.volumes.actions.retrieve(actionID, { ...params }) -> ActionRetrieveResponse
• client.gpuDroplets.volumes.actions.list(volumeID, { ...params }) -> ActionListResponse
• client.gpuDroplets.volumes.actions.initiateByID(volumeID, { ...params }) -> ActionInitiateByIDResponse
• client.gpuDroplets.volumes.actions.initiateByName({ ...params }) -> ActionInitiateByNameResponse

Snapshots

Types:

• SnapshotCreateResponse
• SnapshotRetrieveResponse
• SnapshotListResponse

Methods:

• client.gpuDroplets.volumes.snapshots.create(volumeID, { ...params }) -> SnapshotCreateResponse
• client.gpuDroplets.volumes.snapshots.retrieve(snapshotID) -> SnapshotRetrieveResponse
• client.gpuDroplets.volumes.snapshots.list(volumeID, { ...params }) -> SnapshotListResponse
• client.gpuDroplets.volumes.snapshots.delete(snapshotID) -> void

Account

Keys

Types:

• SSHKeys
• KeyCreateResponse
• KeyRetrieveResponse
• KeyUpdateResponse
• KeyListResponse

Methods:

• client.gpuDroplets.account.keys.create({ ...params }) -> KeyCreateResponse
• client.gpuDroplets.account.keys.retrieve(sshKeyIdentifier) -> KeyRetrieveResponse
• client.gpuDroplets.account.keys.update(sshKeyIdentifier, { ...params }) -> KeyUpdateResponse
• client.gpuDroplets.account.keys.list({ ...params }) -> KeyListResponse
• client.gpuDroplets.account.keys.delete(sshKeyIdentifier) -> void

Inference

APIKeys

Types:

• APIModelAPIKeyInfo
• APIKeyCreateResponse
• APIKeyUpdateResponse
• APIKeyListResponse
• APIKeyDeleteResponse
• APIKeyUpdateRegenerateResponse

Methods:

• client.inference.apiKeys.create({ ...params }) -> APIKeyCreateResponse
• client.inference.apiKeys.update(apiKeyUuid, { ...params }) -> APIKeyUpdateResponse
• client.inference.apiKeys.list({ ...params }) -> APIKeyListResponse
• client.inference.apiKeys.delete(apiKeyUuid) -> APIKeyDeleteResponse
• client.inference.apiKeys.updateRegenerate(apiKeyUuid) -> APIKeyUpdateRegenerateResponse

KnowledgeBases

Types:

• APIKnowledgeBase
• KnowledgeBaseCreateResponse
• KnowledgeBaseRetrieveResponse
• KnowledgeBaseUpdateResponse
• KnowledgeBaseListResponse
• KnowledgeBaseDeleteResponse

Methods:

• client.knowledgeBases.create({ ...params }) -> KnowledgeBaseCreateResponse
• client.knowledgeBases.retrieve(uuid) -> KnowledgeBaseRetrieveResponse
• client.knowledgeBases.update(pathUuid, { ...params }) -> KnowledgeBaseUpdateResponse
• client.knowledgeBases.list({ ...params }) -> KnowledgeBaseListResponse
• client.knowledgeBases.delete(uuid) -> KnowledgeBaseDeleteResponse

DataSources

Types:

• APIFileUploadDataSource
• APIKnowledgeBaseDataSource
• APISpacesDataSource
• APIWebCrawlerDataSource
• AwsDataSource
• DataSourceCreateResponse
• DataSourceListResponse
• DataSourceDeleteResponse
• DataSourceCreatePresignedURLsResponse

Methods:

• client.knowledgeBases.dataSources.create(knowledgeBaseUuid, { ...params }) -> DataSourceCreateResponse
• client.knowledgeBases.dataSources.list(knowledgeBaseUuid, { ...params }) -> DataSourceListResponse
• client.knowledgeBases.dataSources.delete(dataSourceUuid, { ...params }) -> DataSourceDeleteResponse
• client.knowledgeBases.dataSources.createPresignedURLs({ ...params }) -> DataSourceCreatePresignedURLsResponse

IndexingJobs

Types:

• APIIndexedDataSource
• APIIndexingJob
• IndexingJobCreateResponse
• IndexingJobRetrieveResponse
• IndexingJobListResponse
• IndexingJobRetrieveDataSourcesResponse
• IndexingJobUpdateCancelResponse

Methods:

• client.knowledgeBases.indexingJobs.create({ ...params }) -> IndexingJobCreateResponse
• client.knowledgeBases.indexingJobs.retrieve(uuid) -> IndexingJobRetrieveResponse
• client.knowledgeBases.indexingJobs.list({ ...params }) -> IndexingJobListResponse
• client.knowledgeBases.indexingJobs.retrieveDataSources(indexingJobUuid) -> IndexingJobRetrieveDataSourcesResponse
• client.knowledgeBases.indexingJobs.updateCancel(pathUuid, { ...params }) -> IndexingJobUpdateCancelResponse
• client.knowledgeBases.indexingJobs.waitForCompletion(uuid, { ...options }) -> IndexingJobRetrieveResponse

Models

Types:

• APIAgreement
• APIModel
• APIModelVersion
• ModelListResponse

Methods:

• client.models.list({ ...params }) -> ModelListResponse

Providers

Anthropic

Types:

• AnthropicCreateResponse
• AnthropicRetrieveResponse
• AnthropicUpdateResponse
• AnthropicListResponse
• AnthropicDeleteResponse
• AnthropicListAgentsResponse

Methods:

• client.models.providers.anthropic.create({ ...params }) -> AnthropicCreateResponse
• client.models.providers.anthropic.retrieve(apiKeyUuid) -> AnthropicRetrieveResponse
• client.models.providers.anthropic.update(apiKeyUuid, { ...params }) -> AnthropicUpdateResponse
• client.models.providers.anthropic.list({ ...params }) -> AnthropicListResponse
• client.models.providers.anthropic.delete(apiKeyUuid) -> AnthropicDeleteResponse
• client.models.providers.anthropic.listAgents(uuid, { ...params }) -> AnthropicListAgentsResponse

OpenAI

Types:

• OpenAICreateResponse
• OpenAIRetrieveResponse
• OpenAIUpdateResponse
• OpenAIListResponse
• OpenAIDeleteResponse
• OpenAIRetrieveAgentsResponse

Methods:

• client.models.providers.openai.create({ ...params }) -> OpenAICreateResponse
• client.models.providers.openai.retrieve(apiKeyUuid) -> OpenAIRetrieveResponse
• client.models.providers.openai.update(apiKeyUuid, { ...params }) -> OpenAIUpdateResponse
• client.models.providers.openai.list({ ...params }) -> OpenAIListResponse
• client.models.providers.openai.delete(apiKeyUuid) -> OpenAIDeleteResponse
• client.models.providers.openai.retrieveAgents(uuid, { ...params }) -> OpenAIRetrieveAgentsResponse

Regions

Types:

• RegionListResponse

Methods:

• client.regions.list({ ...params }) -> RegionListResponse

Databases

SchemaRegistry

Config

Types:

• ConfigRetrieveResponse
• ConfigUpdateResponse
• ConfigRetrieveSubjectResponse
• ConfigUpdateSubjectResponse

Methods:

• client.databases.schemaRegistry.config.retrieve(databaseClusterUuid) -> ConfigRetrieveResponse
• client.databases.schemaRegistry.config.update(databaseClusterUuid, { ...params }) -> ConfigUpdateResponse
• client.databases.schemaRegistry.config.retrieveSubject(subjectName, { ...params }) -> ConfigRetrieveSubjectResponse
• client.databases.schemaRegistry.config.updateSubject(subjectName, { ...params }) -> ConfigUpdateSubjectResponse