API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Blocks

List Blocks

client.blocks.list(BlockListParams { after, before, connected_to_agents_count_eq, 14 more } query?, RequestOptionsoptions?): ArrayPage<BlockResponse { id, value, base_template_id, 15 more } >

get/v1/blocks/

Create Block

client.blocks.create(BlockCreateParams { label, value, base_template_id, 12 more } body, RequestOptionsoptions?): BlockResponse { id, value, base_template_id, 15 more }

post/v1/blocks/

Modify Block

client.blocks.modify(stringblockID, BlockModifyParams { base_template_id, deployment_id, description, 12 more } body, RequestOptionsoptions?): BlockResponse { id, value, base_template_id, 15 more }

patch/v1/blocks/{block_id}

Delete Block

client.blocks.delete(stringblockID, RequestOptionsoptions?): BlockDeleteResponse

delete/v1/blocks/{block_id}

Retrieve Block

client.blocks.retrieve(stringblockID, RequestOptionsoptions?): BlockResponse { id, value, base_template_id, 15 more }

get/v1/blocks/{block_id}

ModelsExpand Collapse

BlockResponse { id, value, base_template_id, 15 more }

id: string

The id of the block.

value: string

Value of the block.

Deprecatedbase_template_id?: string | null

(Deprecated) The base template id of the block.

created_by_id?: string | null

The id of the user that made this Block.

Deprecateddeployment_id?: string | null

(Deprecated) The id of the deployment.

description?: string | null

Description of the block.

Deprecatedentity_id?: string | null

(Deprecated) The id of the entity within the template.

Deprecatedhidden?: boolean | null

(Deprecated) If set to True, the block will be hidden.

is_template?: boolean

Whether the block is a template (e.g. saved human/persona options).

label?: string | null

Label of the block (e.g. 'human', 'persona') in the context window.

last_updated_by_id?: string | null

The id of the user that last updated this Block.

limit?: number

Character limit of the block.

metadata?: Record<string, unknown> | null

Metadata of the block.

Deprecatedpreserve_on_migration?: boolean | null

(Deprecated) Preserve the block on template migration.

project_id?: string | null

The associated project id.

Deprecatedread_only?: boolean

(Deprecated) Whether the agent has read-only access to the block.

Deprecatedtemplate_id?: string | null

(Deprecated) The id of the template.

Deprecatedtemplate_name?: string | null

(Deprecated) The name of the block template (if it is a template).

CreateBlock { label, value, base_template_id, 12 more }

Create a block

label: string

Label of the block.

value: string

Value of the block.

base_template_id?: string | null

The base template id of the block.

deployment_id?: string | null

The id of the deployment.

description?: string | null

Description of the block.

entity_id?: string | null

The id of the entity within the template.

hidden?: boolean | null

If set to True, the block will be hidden.

is_template?: boolean

limit?: number

Character limit of the block.

metadata?: Record<string, unknown> | null

Metadata of the block.

preserve_on_migration?: boolean | null

Preserve the block on template migration.

project_id?: string | null

The associated project id.

read_only?: boolean

Whether the agent has read-only access to the block.

template_id?: string | null

The id of the template.

template_name?: string | null

Name of the block if it is a template.

BlocksAgents

List Agents For Block

client.blocks.agents.list(stringblockID, AgentListParams { after, before, include, 4 more } query?, RequestOptionsoptions?): ArrayPage<AgentState { id, agent_type, blocks, 39 more } >

get/v1/blocks/{block_id}/agents