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.

List Agents For Block Retrieves all agents associated with the specified block. Raises a 404 if the block does not exist.

Functions

count_blocks(connection, opts \\ [])

@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 server
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, integer()} on success
  • {:error, Tesla.Env.t} on failure

create_block(connection, create_block, opts \\ [])

Create Block

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • create_block (CreateBlock):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, LettaAPI.Model.Block.t} on success
  • {:error, Tesla.Env.t} on failure

delete_block(connection, block_id, opts \\ [])

@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 server
  • block_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

list_agents_for_block(connection, block_id, opts \\ [])

@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 server
  • block_id (String.t):
  • opts (keyword): Optional parameters
    • :user_id (String.t):

Returns

  • {:ok, [%AgentState{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

list_blocks(connection, opts \\ [])

@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 server
  • opts (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

modify_block(connection, block_id, block_update, opts \\ [])

Modify Block

Parameters

  • connection (LettaAPI.Connection): Connection to server
  • block_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

retrieve_block(connection, block_id, opts \\ [])

@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 server
  • block_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