API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Identities

List Identities

client.identities.list(IdentityListParams { after, before, identifier_key, 6 more } query?, RequestOptionsoptions?): ArrayPage<Identity { id, agent_ids, block_ids, 5 more } >

get/v1/identities/

Create Identity

client.identities.create(IdentityCreateParams { identifier_key, identity_type, name, 4 more } body, RequestOptionsoptions?): Identity { id, agent_ids, block_ids, 5 more }

post/v1/identities/

Upsert Identity

client.identities.upsert(IdentityUpsertParams { identifier_key, identity_type, name, 4 more } body, RequestOptionsoptions?): Identity { id, agent_ids, block_ids, 5 more }

put/v1/identities/

Retrieve Identity

client.identities.retrieve(stringidentityID, RequestOptionsoptions?): Identity { id, agent_ids, block_ids, 5 more }

get/v1/identities/{identity_id}

Modify Identity

client.identities.modify(stringidentityID, IdentityModifyParams { agent_ids, block_ids, identifier_key, 3 more } body, RequestOptionsoptions?): Identity { id, agent_ids, block_ids, 5 more }

patch/v1/identities/{identity_id}

Delete Identity

client.identities.delete(stringidentityID, RequestOptionsoptions?): IdentityDeleteResponse

delete/v1/identities/{identity_id}

ModelsExpand Collapse

Identity { id, agent_ids, block_ids, 5 more }

id: string

The human-friendly ID of the Identity

Deprecatedagent_ids: Array<string>

The IDs of the agents associated with the identity.

Deprecatedblock_ids: Array<string>

The IDs of the blocks associated with the identity.

identifier_key: string

External, user-generated identifier key of the identity.

identity_type: IdentityType

The type of the identity.

Accepts one of the following:

"org"

"user"

"other"

name: string

The name of the identity.

project_id?: string | null

The project id of the identity, if applicable.

properties?: Array<IdentityProperty { key, type, value } >

List of properties associated with the identity

key: string

The key of the property

type: "string" | "number" | "boolean" | "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string | number | boolean | Record<string, unknown>

The value of the property

Accepts one of the following:

string

number

boolean

Record<string, unknown>

IdentityProperty { key, type, value }

A property of an identity

key: string

The key of the property

type: "string" | "number" | "boolean" | "json"

The type of the property

Accepts one of the following:

"string"

"number"

"boolean"

"json"

value: string | number | boolean | Record<string, unknown>

The value of the property

Accepts one of the following:

string

number

boolean

Record<string, unknown>

IdentityType = "org" | "user" | "other"

Enum to represent the type of the identity.

Accepts one of the following:

"org"

"user"

"other"

IdentitiesProperties

Upsert Identity Properties

client.identities.properties.upsert(stringidentityID, PropertyUpsertParams { body } params, RequestOptionsoptions?): PropertyUpsertResponse

put/v1/identities/{identity_id}/properties

IdentitiesAgents

List Agents For Identity

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

get/v1/identities/{identity_id}/agents

IdentitiesBlocks

List Blocks For Identity

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

get/v1/identities/{identity_id}/blocks