Files
See how an AI assistant can help with files in Brandwave, including example prompts and the details it may ask for.
Using your AI assistant
List files
List the files attached to one campaign, activity, or creator, including who added each file and whether a person uploaded it or an AI assistant wrote it.
Tool name: list_files. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
List all files in my workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| ownerType | 'campaign' | 'activity' | 'creator' | Required | Which kind of record this file belongs to: campaign, activity, or creator. |
| ownerId | string (UUID) | Required | Identifier of the campaign, activity, or creator. |
| workspaceId | string (UUID) | — | Workspace identifier. |
What you'll get back
Returns { items, totalCount, facets, _meta } with paginated results.
Create file
Create a text, markdown, or CSV file on a campaign, activity, or creator by supplying its content directly. Use this to save a written report, summary, plan, or notes. To keep a file someone shared with you, import it instead.
Tool name: create_file. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=false.
Example prompt
Create a new file.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| ownerType | 'campaign' | 'activity' | 'creator' | Required | Which kind of record this file belongs to: campaign, activity, or creator. |
| ownerId | string (UUID) | Required | Identifier of the campaign, activity, or creator. |
| workspaceId | string (UUID) | — | Workspace identifier. |
| fileName | string | Required | File name including its extension, for example "wrap-report.md". |
| contentType | 'text/markdown' | 'text/plain' | 'text/csv' | Required | Media type of the supplied content. |
| content | string | Required | The complete text content to store. |
| description | string | null | — | Short note about what this file contains and why it was attached. |
What you'll get back
Returns { data, _meta } with the result.
Import file
Add the original of a file someone shared, such as a spreadsheet, PDF, slide deck, document or screenshot, to a campaign, activity, or creator. Brandwave downloads the file from its link and stores a private copy.
Tool name: import_file. Protocol hints: readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true.
Example prompt
Import file for my workspace.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| ownerType | 'campaign' | 'activity' | 'creator' | Required | Which kind of record this file belongs to: campaign, activity, or creator. |
| ownerId | string (UUID) | Required | Identifier of the campaign, activity, or creator. |
| workspaceId | string (UUID) | — | Workspace identifier. |
| file | object | Required | The file to copy into Brandwave. |
| fileName | string | — | A clearer name to store the file under, including its extension. Defaults to the original name. |
| description | string | null | — | Short note about what this file contains and why it was attached. |
What you'll get back
Returns { data, _meta } with the result.
Get file download
Get a short-lived authorized URL for reading one private file, so it can be opened or fetched and analyzed.
Tool name: get_file_download. Protocol hints: readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=false.
Example prompt
Show me the details for this file download.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Unique identifier (UUID v4). |
What you'll get back
Returns { data, _meta } with the result.
Rename file
Update the name of a file attached to a campaign, activity, or creator so it says what the document actually is.
Tool name: update_file. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt
Update the rename file.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Unique identifier (UUID v4). |
| fileName | string | Required | A clearer name for this file, including its extension. |
What you'll get back
Returns { data, _meta } with the result.
Delete file
Remove a file from the campaign, activity, or creator it is attached to.
Tool name: delete_file. Protocol hints: readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=false.
Example prompt
Delete this file.Details to provide
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Required | Unique identifier (UUID v4). |
What you'll get back
Returns { data, _meta } with the result.