API Reference

Beta

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Agent Data

Get Agent Data

client.beta.agentData.get(stringitemID, AgentDataGetParams { organization_id, project_id } query?, RequestOptionsoptions?): AgentData { data, deployment_name, id, 4 more }

GET/api/v1/beta/agent-data/{item_id}

Update Agent Data

client.beta.agentData.update(stringitemID, AgentDataUpdateParams { data, organization_id, project_id } params, RequestOptionsoptions?): AgentData { data, deployment_name, id, 4 more }

PUT/api/v1/beta/agent-data/{item_id}

Delete Agent Data

client.beta.agentData.delete(stringitemID, AgentDataDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): AgentDataDeleteResponse

DELETE/api/v1/beta/agent-data/{item_id}

Create Agent Data

client.beta.agentData.create(AgentDataCreateParams { data, deployment_name, organization_id, 2 more } params, RequestOptionsoptions?): AgentData { data, deployment_name, id, 4 more }

POST/api/v1/beta/agent-data

Search Agent Data

client.beta.agentData.search(AgentDataSearchParams { deployment_name, organization_id, project_id, 7 more } params, RequestOptionsoptions?): PaginatedCursorPost<AgentData { data, deployment_name, id, 4 more } >

POST/api/v1/beta/agent-data/:search

Aggregate Agent Data

client.beta.agentData.aggregate(AgentDataAggregateParams { deployment_name, organization_id, project_id, 9 more } params, RequestOptionsoptions?): PaginatedCursorPost<AgentDataAggregateResponse { group_key, count, first_item } >

POST/api/v1/beta/agent-data/:aggregate

Delete Agent Data By Query

client.beta.agentData.deleteByQuery(AgentDataDeleteByQueryParams { deployment_name, organization_id, project_id, 2 more } params, RequestOptionsoptions?): AgentDataDeleteByQueryResponse { deleted_count }

POST/api/v1/beta/agent-data/:delete

ModelsExpand Collapse

AgentData { data, deployment_name, id, 4 more }

API Result for a single agent data item

data: Record<string, unknown>

deployment_name: string

id?: string | null

collection?: string

created_at?: string | null

project_id?: string | null

updated_at?: string | null

AgentDataDeleteResponse = Record<string, string>

AgentDataAggregateResponse { group_key, count, first_item }

API Result for a single group in the aggregate response

group_key: Record<string, unknown>

count?: number | null

first_item?: Record<string, unknown> | null

AgentDataDeleteByQueryResponse { deleted_count }

API response for bulk delete operation

deleted_count: number