LettaAPI.Api.Providers (letta_api v1.0.0)
API calls for all endpoints tagged Providers
.
Summary
Functions
Create Provider Create a new custom provider
Delete Provider Delete an existing custom provider
List Providers Get a list of all custom providers in the database
Modify Provider Update an existing custom provider
Functions
@spec create_provider( Tesla.Env.client(), LettaAPI.Model.ProviderCreate.t(), keyword() ) :: {:ok, LettaAPI.Model.Provider.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Create Provider Create a new custom provider
Parameters
connection
(LettaAPI.Connection): Connection to serverprovider_create
(ProviderCreate):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Provider.t}
on success{:error, Tesla.Env.t}
on failure
@spec delete_provider(Tesla.Env.client(), String.t(), keyword()) :: {:ok, any()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Delete Provider Delete an existing custom provider
Parameters
connection
(LettaAPI.Connection): Connection to serverprovider_id
(String.t):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, any()}
on success{:error, Tesla.Env.t}
on failure
@spec list_providers( Tesla.Env.client(), keyword() ) :: {:ok, LettaAPI.Model.HttpValidationError.t()} | {:ok, [LettaAPI.Model.Provider.t()]} | {:error, Tesla.Env.t()}
List Providers Get a list of all custom providers in the database
Parameters
connection
(LettaAPI.Connection): Connection to serveropts
(keyword): Optional parameters:name
(String.t)::provider_type
(ProviderType)::after
(String.t)::limit
(integer())::user_id
(String.t):
Returns
{:ok, [%Provider{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec modify_provider( Tesla.Env.client(), String.t(), LettaAPI.Model.ProviderUpdate.t(), keyword() ) :: {:ok, LettaAPI.Model.Provider.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Modify Provider Update an existing custom provider
Parameters
connection
(LettaAPI.Connection): Connection to serverprovider_id
(String.t):provider_update
(ProviderUpdate):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Provider.t}
on success{:error, Tesla.Env.t}
on failure