LettaAPI.Api.Blocks (letta_api v1.0.0)
API calls for all endpoints tagged Blocks
.
Summary
Functions
Count Blocks Count all blocks created by a user.
Create Block
Delete Block
List Agents For Block Retrieves all agents associated with the specified block. Raises a 404 if the block does not exist.
List Blocks
Retrieve Block
Functions
@spec count_blocks( Tesla.Env.client(), keyword() ) :: {:ok, integer()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Count Blocks Count all blocks created by a user.
Parameters
connection
(LettaAPI.Connection): Connection to serveropts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, integer()}
on success{:error, Tesla.Env.t}
on failure
@spec create_block(Tesla.Env.client(), LettaAPI.Model.CreateBlock.t(), keyword()) :: {:ok, LettaAPI.Model.Block.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Create Block
Parameters
connection
(LettaAPI.Connection): Connection to servercreate_block
(CreateBlock):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Block.t}
on success{:error, Tesla.Env.t}
on failure
@spec delete_block(Tesla.Env.client(), String.t(), keyword()) :: {:ok, LettaAPI.Model.Block.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Delete Block
Parameters
connection
(LettaAPI.Connection): Connection to serverblock_id
(String.t):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Block.t}
on success{:error, Tesla.Env.t}
on failure
@spec list_agents_for_block(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [LettaAPI.Model.AgentState.t()]} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
List Agents For Block Retrieves all agents associated with the specified block. Raises a 404 if the block does not exist.
Parameters
connection
(LettaAPI.Connection): Connection to serverblock_id
(String.t):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, [%AgentState{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec list_blocks( Tesla.Env.client(), keyword() ) :: {:ok, [LettaAPI.Model.Block.t()]} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
List Blocks
Parameters
connection
(LettaAPI.Connection): Connection to serveropts
(keyword): Optional parameters:label
(String.t): Labels to include (e.g. human, persona):templates_only
(boolean()): Whether to include only templates:name
(String.t): Name of the block:identity_id
(String.t): Search agents by identifier id:identifier_keys
([String.t]): Search agents by identifier keys:user_id
(String.t):
Returns
{:ok, [%Block{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec modify_block( Tesla.Env.client(), String.t(), LettaAPI.Model.BlockUpdate.t(), keyword() ) :: {:ok, LettaAPI.Model.Block.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Modify Block
Parameters
connection
(LettaAPI.Connection): Connection to serverblock_id
(String.t):block_update
(BlockUpdate):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Block.t}
on success{:error, Tesla.Env.t}
on failure
@spec retrieve_block(Tesla.Env.client(), String.t(), keyword()) :: {:ok, LettaAPI.Model.Block.t()} | {:ok, LettaAPI.Model.HttpValidationError.t()} | {:error, Tesla.Env.t()}
Retrieve Block
Parameters
connection
(LettaAPI.Connection): Connection to serverblock_id
(String.t):opts
(keyword): Optional parameters:user_id
(String.t):
Returns
{:ok, LettaAPI.Model.Block.t}
on success{:error, Tesla.Env.t}
on failure