files — @personaai/sdk

Generated field tables for files — do not edit

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

files

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

Files are user uploads (multipart file part) scoped to an optional agentId/threadId.

Example

TypeScript

const file = await userClient.files.upload({ filename: 'notes.pdf', content: buf, agentId: agent._id });const list = await userClient.files.list({ page: 1, limit: 20 });

const file = await userClient.files.upload({ filename: 'notes.pdf', content: buf, agentId: agent._id });const list = await userClient.files.list({ page: 1, limit: 20 });

cURL

bash

curl https://api.persona.hasanraiyan.me/api/v1/developer/files \  -H "Authorization: Bearer $PERSONA_CREDENTIAL" -H "x-persona-external-user-id: user_123" \  -F file=@notes.pdf -F agentId=ag_123

curl https://api.persona.hasanraiyan.me/api/v1/developer/files \  -H "Authorization: Bearer $PERSONA_CREDENTIAL" -H "x-persona-external-user-id: user_123" \  -F file=@notes.pdf -F agentId=ag_123

Response

json

{  "success": true,  "data": { "items": [{ "id": "file_123", "originalName": "notes.pdf" }], "pagination": { "total": 1 } }}

{  "success": true,  "data": { "items": [{ "id": "file_123", "originalName": "notes.pdf" }], "pagination": { "total": 1 } }}

`PersonaFile`

Clean formatted shape (id, not _id) — unlike Thread/Skill/Agent/Knowledge.

Source: types/file.ts:2

Interface

Field	Type	Description
`id`	`string`	— _ `types/file.ts:3`_
`originalName`	`string`	— _ `types/file.ts:4`_
`mimeType`	`string`	— _ `types/file.ts:5`_
`size`	`number`	Bytes. — _ `types/file.ts:7`_
`agentId`	`string \| null`	— _ `types/file.ts:8`_
`threadId`	`string \| null`	— _ `types/file.ts:9`_
`createdAt`	`string`	— _ `types/file.ts:10`_

`UploadFilePayload`

Source: types/file.ts:13

Interface

Field	Type	Description
`filename`	`string`	— _ `types/file.ts:14`_
`content`	`Uint8Array<ArrayBufferLike> \| Blob`	Node Buffer/Uint8Array, or an already-constructed Blob. — _ `types/file.ts:16`_
`contentType?`	`string`	e.g. `'application/pdf'`. Required when `content` isn't already a `Blob` with its own `type`. — _ `types/file.ts:18`_
`agentId?`	`string`	Associates this file with an Agent, e.g. for later reference in that Agent's tool calls. — _ `types/file.ts:20`_
`threadId?`	`string`	Associates this file with a specific Thread/conversation. — _ `types/file.ts:22`_

`ListFilesParams`

Source: types/file.ts:25

Interface

Field	Type	Description
`page?`	`number`	— _ `types/file.ts:27`_
`limit?`	`number`	— _ `types/file.ts:29`_

chat — @personaai/sdk

knowledge — @personaai/sdk