Skip to main content

​
list

List all inference providers. 
client.inference_providers.list(
    limit=10,
    cursor="abc123"
)
​
limit
int
Maximum number of items to return per page
​
cursor
str
Pagination cursor for fetching the next page
​
data
List[InferenceProvider]
List of inference provider objects
​
next_cursor
str | None
Cursor for the next page, or None if no more results

​
get

Retrieve a specific inference provider by UID. 
client.inference_providers.get("ip_abc123")
​
uid
str
required
Unique identifier of the inference provider
​
uid
str
Unique identifier for the inference provider
​
name
str
Name of the inference provider
​
provider_type
str
Type of provider (e.g., “openai”, “anthropic”, “custom”)
​
config
dict
Provider-specific configuration settings
​
is_active
bool
Whether the provider is currently active

​
create

Create a new inference provider configuration. 
client.inference_providers.create(
    name="OpenAI GPT-4",
    provider_type="openai",
    config={
        "api_key": "sk-...",
        "model": "gpt-4",
        "temperature": 0.7
    },
    description="Production OpenAI provider",
    is_active=True,
    project="proj_xyz789"
)
​
name
str
required
Name for this inference provider
​
provider_type
str
required
Type of provider (e.g., “openai”, “anthropic”, “azure”, “custom”)
​
config
dict
required
Provider-specific configuration object (API keys, endpoints, model parameters)
​
description
str
Optional description of this provider configuration
​
is_active
bool
Whether this provider should be active (default: true)
​
project
str
UID of the project to associate this provider with
​
uid
str
Unique identifier for the inference provider
​
name
str
Name of the inference provider
​
provider_type
str
Type of provider
​
config
dict
Provider configuration

​
update

Update an existing inference provider. 
client.inference_providers.update(
    "ip_abc123",
    name="Updated Provider Name",
    config={
        "api_key": "sk-new-key",
        "model": "gpt-4-turbo"
    },
    is_active=False
)
​
uid
str
required
Unique identifier of the inference provider to update
​
name
str
Updated name for the provider
​
description
str
Updated description
​
provider_type
str
Updated provider type
​
config
dict
Updated configuration object
​
is_active
bool
Updated active status
​
project
str
Updated project association
​
uid
str
Unique identifier for the inference provider
​
name
str
Updated name
​
provider_type
str
Provider type
​
config
dict
Updated configuration

​
delete

Delete an inference provider. 
client.inference_providers.delete("ip_abc123")
​
uid
str
required
Unique identifier of the inference provider to delete

​
test

Test an inference provider to verify connectivity and configuration. 
client.inference_providers.test("ip_abc123")
​
uid
str
required
Unique identifier of the inference provider to test
​
success
bool
Whether the test was successful
​
message
str
Test result message or error details
​
latency_ms
float
Response latency in milliseconds

Build docs developers (and LLMs) love

Get started for freeTalk to us