threads — @personaai/sdk

Generated field tables for threads — do not edit

Generated from sdk/typescript/dist/typedoc.json — do not edit. Regenerate with node platform/scripts/typedoc-resources.mjs.

threads

Auth: Requires Authorization: Bearer <keyId>.<secret> (server-side). For per-user calls add x-persona-external-user-id. See .

Threads scope messages, files, todos, and checkpoints to one conversation. Use externalUserId so threads belong to your user.

Example

TypeScript

const userClient = new PersonaClient({ baseUrl, credential, externalUserId: currentUser.id });const thread = await userClient.threads.create({ agentId: agent._id });for await (const e of userClient.chat.stream(agent._id, { messages: [{ role:'user', content:'Hi' }], threadId: thread._id })) {}

const userClient = new PersonaClient({ baseUrl, credential, externalUserId: currentUser.id });const thread = await userClient.threads.create({ agentId: agent._id });for await (const e of userClient.chat.stream(agent._id, { messages: [{ role:'user', content:'Hi' }], threadId: thread._id })) {}

cURL

bash

curl https://api.persona.hasanraiyan.me/api/v1/developer/threads \  -H "Authorization: Bearer $PERSONA_CREDENTIAL" -H "x-persona-external-user-id: user_123" \  -H "Content-Type: application/json" -d '{"agentId":"ag_123"}'

curl https://api.persona.hasanraiyan.me/api/v1/developer/threads \  -H "Authorization: Bearer $PERSONA_CREDENTIAL" -H "x-persona-external-user-id: user_123" \  -H "Content-Type: application/json" -d '{"agentId":"ag_123"}'

Response

`Thread`

Like Skill/Agent/Knowledge/Mcp, this mirrors the real wire shape (_id).

Source: types/thread.ts:4

Interface

Field	Type	Description
`_id`	`string`	— _ `types/thread.ts:5`_
`domain`	`string`	— _ `types/thread.ts:6`_
`agentId`	`string \| { _id: string; name: string; avatar: string; slug: string }`	Populated as `{ _id, name, avatar, slug }` on `list()`; a bare id on `create()`/`get()`. — _ `types/thread.ts:8`_
`subjectType`	`"PersonaUser" \| "ExternalUser"`	— _ `types/thread.ts:9`_
`userId?`	`string`	— _ `types/thread.ts:10`_
`externalUserId?`	`string`	— _ `types/thread.ts:11`_
`threadId`	`string`	The deterministic AG-UI thread id used for streaming (`x-thread-id`) — distinct from `_id`. — _ `types/thread.ts:13`_
`title`	`string`	— _ `types/thread.ts:14`_
`lastMessageAt`	`string`	— _ `types/thread.ts:15`_
`isArchived`	`boolean`	— _ `types/thread.ts:16`_
`subagentTraces?`	`Record<string, unknown>`	— _ `types/thread.ts:17`_
`createdAt`	`string`	— _ `types/thread.ts:18`_
`updatedAt`	`string`	— _ `types/thread.ts:19`_

`CreateThreadInput`

Source: types/thread.ts:22

Interface

Field	Type	Description
`agentId`	`string`	The Agent this Thread's conversation is with. — _ `types/thread.ts:24`_

`UpdateThreadInput`

All fields optional — only what you pass is changed.

Source: types/thread.ts:28

Interface

Field	Type	Description
`title?`	`string`	— _ `types/thread.ts:29`_
`isArchived?`	`boolean`	— _ `types/thread.ts:30`_

`ListThreadsParams`

Source: types/thread.ts:33

Interface

Field	Type	Description
`page?`	`number`	— _ `types/thread.ts:35`_
`limit?`	`number`	— _ `types/thread.ts:37`_

`ThreadMessages`

messages holds raw LangChain message objects (role/content/tool_calls vary by message type) — intentionally untyped rather than guessing at a shape this SDK doesn't own.

Source: types/thread.ts:45

Interface

Field	Type	Description
`messages`	`unknown[]`	— _ `types/thread.ts:46`_
`state`	`Record<string, unknown>`	— _ `types/thread.ts:47`_
`subagentTraces`	`Record<string, unknown>`	— _ `types/thread.ts:48`_
`pendingInterrupt?`	`ChatInterrupt`	Set when this Thread is currently paused on a HITL/clarification interrupt — lets a caller re-show the approval/clarification card on page load without waiting for the next live `chat.stream()` call to re-surface it. Same shape as `ChatResult.interrupt`. Named `pendingInterrupt` (not `interrupt`) to match the actual wire field checkpointService.getMessages() returns. — _ `types/thread.ts:57`_

stores — @personaai/sdk

voice — @personaai/sdk