Skip to content
Gradient SDK Docs
Search
Ctrl
K
Auto
Light
Dark
Language
HTTP
Python
Getting Started
Overview
Gradient API
Serverless Inference
Agent Inference
Streaming
Handling errors
API Reference
Overview
Agents
Overview
Create an Agent
Delete an Agent
List Agents
Retrieve an Existing Agent
Update an Agent
Update Agent Status
API Keys
Create an Agent API Key
Delete API Key for an Agent
List Agent API Keys
Regenerate API Key for an Agent
Update API Key for an Agent
Chat
Completions
Creates a model response for the given chat conversation.
Evaluation Metrics
List Evaluation Metrics
List Datacenter Regions
Workspaces
Create a Workspace
Delete a Workspace
List Workspaces
List Evaluation Test Cases by Workspace
Retrieve an Existing Workspace
Update a Workspace
Agents
List agents by Workspace
Move Agents to a Workspace
Models
List Available Models
Evaluation Runs
Run an Evaluation Test Case
Retrieve Results of an Evaluation Run
Retrieve Information About an Existing Evaluation Run
Retrieve Results of an Evaluation Run Prompt
Evaluation Test Cases
Create Evaluation Test Case.
List Evaluation Test Cases
List Evaluation Runs by Test Case
Retrieve Information About an Existing Evaluation Test Case
Update an Evaluation Test Case.
Evaluation Datasets
Create Evaluation Dataset
Create Presigned URLs for Evaluation Dataset File Upload
Functions
Add Function Route to an Agent
Delete Function Route for an Agent
Update Function Route for an Agent
Versions
List Agent Versions
Rollback to Agent Version
Knowledge Bases
Attach Knowledge Bases to an Agent
Attach Knowledge Base to an Agent
Detach Knowledge Base from an Agent
Routes
Add Agent Route to an Agent
Delete Agent Route for an Agent
Update Agent Route for an Agent
View Agent Routes
Chat
Overview
Completions
Creates a model response for the given chat conversation.
GPU Droplets
Overview
Create a New Droplet
Delete an Existing Droplet
Deleting Droplets by Tag
List All Droplets
List all Firewalls Applied to a Droplet
List All Available Kernels for a Droplet
List Neighbors for a Droplet
List Snapshots for a Droplet
Retrieve an Existing Droplet
Backups
List Backups for a Droplet
List Backup Policies for All Existing Droplets
List Supported Droplet Backup Policies
Retrieve the Backup Policy for an Existing Droplet
Actions
Acting on Tagged Droplets
Initiate a Droplet Action
List Actions for a Droplet
Retrieve a Droplet Action
Destroy With Associated Resources
Check Status of a Droplet Destroy with Associated Resources Request
Destroy a Droplet and All of its Associated Resources (Dangerous)
Selectively Destroy a Droplet and its Associated Resources
List Associated Resources for a Droplet
Retry a Droplet Destroy with Associated Resources Request
Autoscale
Create a New Autoscale Pool
Delete autoscale pool
Delete autoscale pool and resources
List All Autoscale Pools
List history events
List members
Retrieve an Existing Autoscale Pool
Update Autoscale Pool
Firewalls
Create a New Firewall
Delete a Firewall
List All Firewalls
Retrieve an Existing Firewall
Update a Firewall
Droplets
Add Droplets to a Firewall
Remove Droplets from a Firewall
Tags
Add Tags to a Firewall
Remove Tags from a Firewall
Rules
Add Rules to a Firewall
Remove Rules from a Firewall
Floating IPs
Create a New Floating IP
Delete a Floating IP
List All Floating IPs
Retrieve an Existing Floating IP
Actions
Initiate a Floating IP Action
List All Actions for a Floating IP
Retrieve an Existing Floating IP Action
Images
Create a Custom Image
Delete an Image
List All Images
Retrieve an Existing Image
Update an Image
Actions
Initiate an Image Action
List All Actions for an Image
Retrieve an Existing Action
Load Balancers
Create a New Load Balancer
Delete a Load Balancer
Delete a Global Load Balancer CDN Cache
List All Load Balancers
Retrieve an Existing Load Balancer
Update a Load Balancer
Droplets
Add Droplets to a Load Balancer
Remove Droplets from a Load Balancer
Forwarding Rules
Add Forwarding Rules to a Load Balancer
Remove Forwarding Rules from a Load Balancer
Sizes
List All Droplet Sizes
Snapshots
Delete a Snapshot
List All Snapshots
Retrieve an Existing Snapshot
Volumes
Create a New Block Storage Volume
Delete a Block Storage Volume
Delete a Block Storage Volume by Name
List All Block Storage Volumes
Retrieve an Existing Block Storage Volume
Actions
Initiate A Block Storage Action By Volume Id
Initiate A Block Storage Action By Volume Name
List All Actions for a Volume
Retrieve an Existing Volume Action
Snapshots
Create Snapshot from a Volume
Delete a Volume Snapshot
List Snapshots for a Volume
Retrieve an Existing Volume Snapshot
Account
Keys
Create a New SSH Key
Delete an SSH Key
List All SSH Keys
Retrieve an Existing SSH Key
Update an SSH Key's Name
Inference
Overview
API Keys
Create a Model API Key
Delete API Key for a Model
List Model API Keys
Update API Key for a Model
Regenerate API Key for a Model
Knowledge Bases
Overview
Create a Knowledge Base
Delete a Knowledge Base
List Knowledge Bases
Retrieve Information About an Existing Knowledge Base
Update a Knowledge Base
Data Sources
Add Data Source to a Knowledge Base
Delete a Data Source from a Knowledge Base
List Data Sources for a Knowledge Base
Indexing Jobs
Start Indexing Job for a Knowledge Base
List Indexing Jobs for a Knowledge Base
Retrieve Status of Indexing Job for a Knowledge Base
List Data Sources for Indexing Job for a Knowledge Base
Cancel Indexing Job for a Knowledge Base
Models
Overview
Lists the currently available models, and provides basic information about each one such as the owner and availability.
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
Providers
Anthropic
Create Anthropic API Key
Delete Anthropic API Key
List Anthropic API Keys
List agents by Anthropic key
Get Anthropic API Key
Update Anthropic API Key
OpenAI
Create OpenAI API Key
Delete OpenAI API Key
List OpenAI API Keys
Get OpenAI API Key
List agents by OpenAI key
Update OpenAI API Key
Regions
Overview
List All Data Center Regions
Shared
Overview
GitHub
Auto
Light
Dark
Regions
Regions
Regions
List All Data Center Regions
get
/v2/regions
