Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

API Reference

Libraries

Python
0.0.1-alpha.0
pip install --pre do_gradientai
Read Docs

API Overview

Agents

Create an Agent
post/v2/gen-ai/agents
Delete an Agent
delete/v2/gen-ai/agents/{uuid}
List Agents
get/v2/gen-ai/agents
Retrieve an Existing Agent
get/v2/gen-ai/agents/{uuid}
Update an Agent
put/v2/gen-ai/agents/{uuid}
Update Agent Status
put/v2/gen-ai/agents/{uuid}/deployment_visibility

AgentsAPI Keys

Create an Agent API Key
post/v2/gen-ai/agents/{agent_uuid}/api_keys
Delete API Key for an Agent
delete/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}
List Agent API Keys
get/v2/gen-ai/agents/{agent_uuid}/api_keys
Regenerate API Key for an Agent
put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate
Update API Key for an Agent
put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}

AgentsChat

AgentsChatCompletions

Creates a model response for the given chat conversation.
post/chat/completions?agent=true

AgentsEvaluation Datasets

Create Evaluation Dataset
post/v2/gen-ai/evaluation_datasets
Create Presigned URLs for Evaluation Dataset File Upload
post/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls

AgentsEvaluation Metrics

List Evaluation Metrics
get/v2/gen-ai/evaluation_metrics
List Datacenter Regions
get/v2/gen-ai/regions

AgentsEvaluation MetricsModels

List Available Models
get/v2/gen-ai/models

AgentsEvaluation MetricsWorkspaces

Create a Workspace
post/v2/gen-ai/workspaces
Delete a Workspace
delete/v2/gen-ai/workspaces/{workspace_uuid}
List Workspaces
get/v2/gen-ai/workspaces
List Evaluation Test Cases by Workspace
get/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases
Retrieve an Existing Workspace
get/v2/gen-ai/workspaces/{workspace_uuid}
Update a Workspace
put/v2/gen-ai/workspaces/{workspace_uuid}

AgentsEvaluation MetricsWorkspacesAgents

List agents by Workspace
get/v2/gen-ai/workspaces/{workspace_uuid}/agents
Move Agents to a Workspace
put/v2/gen-ai/workspaces/{workspace_uuid}/agents

AgentsEvaluation Runs

Run an Evaluation Test Case
post/v2/gen-ai/evaluation_runs
Retrieve Results of an Evaluation Run
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results
Retrieve Information About an Existing Evaluation Run
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}
Retrieve Results of an Evaluation Run Prompt
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}

AgentsEvaluation Test Cases

Create Evaluation Test Case.
post/v2/gen-ai/evaluation_test_cases
List Evaluation Test Cases
get/v2/gen-ai/evaluation_test_cases
List Evaluation Runs by Test Case
get/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs
Retrieve Information About an Existing Evaluation Test Case
get/v2/gen-ai/evaluation_test_cases/{test_case_uuid}
Update an Evaluation Test Case.
put/v2/gen-ai/evaluation_test_cases/{test_case_uuid}

AgentsFunctions

Add Function Route to an Agent
post/v2/gen-ai/agents/{agent_uuid}/functions
Delete Function Route for an Agent
delete/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}
Update Function Route for an Agent
put/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}

AgentsKnowledge Bases

Attach Knowledge Bases to an Agent
post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases
Attach Knowledge Base to an Agent
post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}
Detach Knowledge Base from an Agent
delete/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}

AgentsRoutes

Add Agent Route to an Agent
post/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}
Delete Agent Route for an Agent
delete/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}
Update Agent Route for an Agent
put/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}
View Agent Routes
get/v2/gen-ai/agents/{uuid}/child_agents

AgentsVersions

List Agent Versions
get/v2/gen-ai/agents/{uuid}/versions
Rollback to Agent Version
put/v2/gen-ai/agents/{uuid}/versions

Chat

ChatCompletions

Creates a model response for the given chat conversation.
post/chat/completions

GPU Droplets

Create a New Droplet
post/v2/droplets
Delete an Existing Droplet
delete/v2/droplets/{droplet_id}
Deleting Droplets by Tag
delete/v2/droplets
List All Droplets
get/v2/droplets
List all Firewalls Applied to a Droplet
get/v2/droplets/{droplet_id}/firewalls
List All Available Kernels for a Droplet
get/v2/droplets/{droplet_id}/kernels
List Neighbors for a Droplet
get/v2/droplets/{droplet_id}/neighbors
List Snapshots for a Droplet
get/v2/droplets/{droplet_id}/snapshots
Retrieve an Existing Droplet
get/v2/droplets/{droplet_id}

GPU DropletsAccount

GPU DropletsAccountKeys

Create a New SSH Key
post/v2/account/keys
Delete an SSH Key
delete/v2/account/keys/{ssh_key_identifier}
List All SSH Keys
get/v2/account/keys
Retrieve an Existing SSH Key
get/v2/account/keys/{ssh_key_identifier}
Update an SSH Key's Name
put/v2/account/keys/{ssh_key_identifier}

GPU DropletsActions

Acting on Tagged Droplets
post/v2/droplets/actions
Initiate a Droplet Action
post/v2/droplets/{droplet_id}/actions
List Actions for a Droplet
get/v2/droplets/{droplet_id}/actions
Retrieve a Droplet Action
get/v2/droplets/{droplet_id}/actions/{action_id}

GPU DropletsAutoscale

Create a New Autoscale Pool
post/v2/droplets/autoscale
Delete autoscale pool
delete/v2/droplets/autoscale/{autoscale_pool_id}
Delete autoscale pool and resources
delete/v2/droplets/autoscale/{autoscale_pool_id}/dangerous
List All Autoscale Pools
get/v2/droplets/autoscale
List history events
get/v2/droplets/autoscale/{autoscale_pool_id}/history
List members
get/v2/droplets/autoscale/{autoscale_pool_id}/members
Retrieve an Existing Autoscale Pool
get/v2/droplets/autoscale/{autoscale_pool_id}
Update Autoscale Pool
put/v2/droplets/autoscale/{autoscale_pool_id}

GPU DropletsBackups

List Backups for a Droplet
get/v2/droplets/{droplet_id}/backups
List Backup Policies for All Existing Droplets
get/v2/droplets/backups/policies
List Supported Droplet Backup Policies
get/v2/droplets/backups/supported_policies
Retrieve the Backup Policy for an Existing Droplet
get/v2/droplets/{droplet_id}/backups/policy

GPU DropletsDestroy With Associated Resources

Check Status of a Droplet Destroy with Associated Resources Request
get/v2/droplets/{droplet_id}/destroy_with_associated_resources/status
Destroy a Droplet and All of its Associated Resources (Dangerous)
delete/v2/droplets/{droplet_id}/destroy_with_associated_resources/dangerous
Selectively Destroy a Droplet and its Associated Resources
delete/v2/droplets/{droplet_id}/destroy_with_associated_resources/selective
List Associated Resources for a Droplet
get/v2/droplets/{droplet_id}/destroy_with_associated_resources
Retry a Droplet Destroy with Associated Resources Request
post/v2/droplets/{droplet_id}/destroy_with_associated_resources/retry

GPU DropletsFirewalls

Create a New Firewall
post/v2/firewalls
Delete a Firewall
delete/v2/firewalls/{firewall_id}
List All Firewalls
get/v2/firewalls
Retrieve an Existing Firewall
get/v2/firewalls/{firewall_id}
Update a Firewall
put/v2/firewalls/{firewall_id}

GPU DropletsFirewallsDroplets

Add Droplets to a Firewall
post/v2/firewalls/{firewall_id}/droplets
Remove Droplets from a Firewall
delete/v2/firewalls/{firewall_id}/droplets

GPU DropletsFirewallsRules

Add Rules to a Firewall
post/v2/firewalls/{firewall_id}/rules
Remove Rules from a Firewall
delete/v2/firewalls/{firewall_id}/rules

GPU DropletsFirewallsTags

Add Tags to a Firewall
post/v2/firewalls/{firewall_id}/tags
Remove Tags from a Firewall
delete/v2/firewalls/{firewall_id}/tags

GPU DropletsFloating IPs

Create a New Floating IP
post/v2/floating_ips
Delete a Floating IP
delete/v2/floating_ips/{floating_ip}
List All Floating IPs
get/v2/floating_ips
Retrieve an Existing Floating IP
get/v2/floating_ips/{floating_ip}

GPU DropletsFloating IPsActions

Initiate a Floating IP Action
post/v2/floating_ips/{floating_ip}/actions
List All Actions for a Floating IP
get/v2/floating_ips/{floating_ip}/actions
Retrieve an Existing Floating IP Action
get/v2/floating_ips/{floating_ip}/actions/{action_id}

GPU DropletsImages

Create a Custom Image
post/v2/images
Delete an Image
delete/v2/images/{image_id}
List All Images
get/v2/images
Retrieve an Existing Image
get/v2/images/{image_id}
Update an Image
put/v2/images/{image_id}

GPU DropletsImagesActions

Initiate an Image Action
post/v2/images/{image_id}/actions
List All Actions for an Image
get/v2/images/{image_id}/actions
Retrieve an Existing Action
get/v2/images/{image_id}/actions/{action_id}

GPU DropletsLoad Balancers

Create a New Load Balancer
post/v2/load_balancers
Delete a Load Balancer
delete/v2/load_balancers/{lb_id}
Delete a Global Load Balancer CDN Cache
delete/v2/load_balancers/{lb_id}/cache
List All Load Balancers
get/v2/load_balancers
Retrieve an Existing Load Balancer
get/v2/load_balancers/{lb_id}
Update a Load Balancer
put/v2/load_balancers/{lb_id}

GPU DropletsLoad BalancersDroplets

Add Droplets to a Load Balancer
post/v2/load_balancers/{lb_id}/droplets
Remove Droplets from a Load Balancer
delete/v2/load_balancers/{lb_id}/droplets

GPU DropletsLoad BalancersForwarding Rules

Add Forwarding Rules to a Load Balancer
post/v2/load_balancers/{lb_id}/forwarding_rules
Remove Forwarding Rules from a Load Balancer
delete/v2/load_balancers/{lb_id}/forwarding_rules

GPU DropletsSizes

List All Droplet Sizes
get/v2/sizes

GPU DropletsSnapshots

Delete a Snapshot
delete/v2/snapshots/{snapshot_id}
List All Snapshots
get/v2/snapshots
Retrieve an Existing Snapshot
get/v2/snapshots/{snapshot_id}

GPU DropletsVolumes

Create a New Block Storage Volume
post/v2/volumes
Delete a Block Storage Volume
delete/v2/volumes/{volume_id}
Delete a Block Storage Volume by Name
delete/v2/volumes
List All Block Storage Volumes
get/v2/volumes
Retrieve an Existing Block Storage Volume
get/v2/volumes/{volume_id}

GPU DropletsVolumesActions

Initiate A Block Storage Action By Volume Id
post/v2/volumes/{volume_id}/actions
Initiate A Block Storage Action By Volume Name
post/v2/volumes/actions
List All Actions for a Volume
get/v2/volumes/{volume_id}/actions
Retrieve an Existing Volume Action
get/v2/volumes/{volume_id}/actions/{action_id}

GPU DropletsVolumesSnapshots

Create Snapshot from a Volume
post/v2/volumes/{volume_id}/snapshots
Delete a Volume Snapshot
delete/v2/volumes/snapshots/{snapshot_id}
List Snapshots for a Volume
get/v2/volumes/{volume_id}/snapshots
Retrieve an Existing Volume Snapshot
get/v2/volumes/snapshots/{snapshot_id}

Inference

InferenceAPI Keys

Create a Model API Key
post/v2/gen-ai/models/api_keys
Delete API Key for a Model
delete/v2/gen-ai/models/api_keys/{api_key_uuid}
List Model API Keys
get/v2/gen-ai/models/api_keys
Update API Key for a Model
put/v2/gen-ai/models/api_keys/{api_key_uuid}
Regenerate API Key for a Model
put/v2/gen-ai/models/api_keys/{api_key_uuid}/regenerate

Knowledge Bases

Create a Knowledge Base
post/v2/gen-ai/knowledge_bases
Delete a Knowledge Base
delete/v2/gen-ai/knowledge_bases/{uuid}
List Knowledge Bases
get/v2/gen-ai/knowledge_bases
Retrieve Information About an Existing Knowledge Base
get/v2/gen-ai/knowledge_bases/{uuid}
Update a Knowledge Base
put/v2/gen-ai/knowledge_bases/{uuid}

Knowledge BasesData Sources

Add Data Source to a Knowledge Base
post/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources
Delete a Data Source from a Knowledge Base
delete/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}
List Data Sources for a Knowledge Base
get/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources

Knowledge BasesIndexing Jobs

Start Indexing Job for a Knowledge Base
post/v2/gen-ai/indexing_jobs
List Indexing Jobs for a Knowledge Base
get/v2/gen-ai/indexing_jobs
Retrieve Status of Indexing Job for a Knowledge Base
get/v2/gen-ai/indexing_jobs/{uuid}
List Data Sources for Indexing Job for a Knowledge Base
get/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources
Cancel Indexing Job for a Knowledge Base
put/v2/gen-ai/indexing_jobs/{uuid}/cancel

Models

Lists the currently available models, and provides basic information about each one such as the owner and availability.
get/models
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
get/models/{model}

ModelsProviders

ModelsProvidersAnthropic

Create Anthropic API Key
post/v2/gen-ai/anthropic/keys
Delete Anthropic API Key
delete/v2/gen-ai/anthropic/keys/{api_key_uuid}
List Anthropic API Keys
get/v2/gen-ai/anthropic/keys
List agents by Anthropic key
get/v2/gen-ai/anthropic/keys/{uuid}/agents
Get Anthropic API Key
get/v2/gen-ai/anthropic/keys/{api_key_uuid}
Update Anthropic API Key
put/v2/gen-ai/anthropic/keys/{api_key_uuid}

ModelsProvidersOpenAI

Create OpenAI API Key
post/v2/gen-ai/openai/keys
Delete OpenAI API Key
delete/v2/gen-ai/openai/keys/{api_key_uuid}
List OpenAI API Keys
get/v2/gen-ai/openai/keys
Get OpenAI API Key
get/v2/gen-ai/openai/keys/{api_key_uuid}
List agents by OpenAI key
get/v2/gen-ai/openai/keys/{uuid}/agents
Update OpenAI API Key
put/v2/gen-ai/openai/keys/{api_key_uuid}

Regions

List All Data Center Regions
get/v2/regions