Skip to main content

Interface: FileAccessEntry

Defined in: packages/sdk/src/types/ability-types.ts:120

Config for a single file access entry

Properties

canRead?

optional canRead: boolean

Defined in: packages/sdk/src/types/ability-types.ts:124

Allow reading file contents (default: true)


canReadAloud?

optional canReadAloud: boolean

Defined in: packages/sdk/src/types/ability-types.ts:132

Allow speaking this file verbatim to the caller on voice chats (default: false). Separate from canRead: reference material the agent consults is not a script it narrates.


canWrite?

optional canWrite: boolean

Defined in: packages/sdk/src/types/ability-types.ts:126

Allow writing/editing file contents (default: false)


fileId

fileId: number

Defined in: packages/sdk/src/types/ability-types.ts:122

ID of the file to provide access to


hint?

optional hint: string

Defined in: packages/sdk/src/types/ability-types.ts:134

Optional hint for the LLM about when/how to use this file