The Brief

Q: How do I connect The Brief to my app?

Use Weavz Hosted Connect for custom authentication. Install the SDK, create a connection through the connect portal or API, then execute tools programmatically.

Q: Does The Brief work with Claude Code, Cursor, Codex, and local agents?

Yes. Remote or local MCP clients can connect to a Weavz MCP endpoint for the workspace. Local coding agents can also use the Weavz CLI to inspect apps, discover actions, and run approved The Brief work from a terminal.

Q: Can The Brief be used in stateful agent workflows?

Yes. Weavz lets agents combine The Brief tools with Filesystem, State KV, Human Gates, input partials, and other workspace integrations while keeping execution scoped to the selected workspace or end user.

Q: What authentication does The Brief use?

The Brief uses custom authentication. Weavz stores credentials securely and uses them for authorized action execution.

Automate The Brief creative exports, brand kits, templates, projects, users, webhooks, ad serving, and credit reports.

CustomContent & Files Marketing

79 tools

12 triggers

Use withChatGPTClaudeClaude CodeCursorCodexMCP clientsSetup guide

Tools

Triggers

Name	Description
`export_status_changed` Triggers when the export id status changes.	Triggers when the export id status changes.
`export_completed` Triggers when the export id reaches complete or completed or success or succeeded.	Triggers when the export id reaches complete or completed or success or succeeded.
`export_failed` Triggers when the export id reaches failed or error.	Triggers when the export id reaches failed or error.
`creative_status_changed` Triggers when the creative id status changes.	Triggers when the creative id status changes.
`creative_completed` Triggers when the creative id reaches complete or completed or success or succeeded.	Triggers when the creative id reaches complete or completed or success or succeeded.
`creative_failed` Triggers when the creative id reaches failed or error.	Triggers when the creative id reaches failed or error.
`new_design` Triggers when a new design appears in the first page of the design list.	Triggers when a new design appears in the first page of the design list.
`new_template` Triggers when a new template appears in the first page of the template list.	Triggers when a new template appears in the first page of the template list.
`new_brand_template` Triggers when a new brand template appears in the first page of the brand-template list.	Triggers when a new brand template appears in the first page of the brand-template list.
`new_project` Triggers when a new project appears in the first page of the project list.	Triggers when a new project appears in the first page of the project list.
`new_team_user` Triggers when a new team user appears in the first page of the users list.	Triggers when a new team user appears in the first page of the users list.
`new_webhook` Triggers when a new team webhook appears in the webhook list.	Triggers when a new team webhook appears in the webhook list.

Quick Start

TypeScript

import { WeavzClient } from '@weavz-io/sdk'

const weavz = new WeavzClient({ apiKey: 'wvz_...' })

const result = await weavz.actions.execute('the-brief', 'create_export_with_changes', {
  workspaceId: '550e8400-e29b-41d4-a716-446655440000',
  integrationAlias: 'the-brief',
  input: { /* ... */ },
})

API Reference TypeScript SDK Python SDK All Features Pricing

Related Integrations

ActiveCampaign

12 tools

Adobe Express

5 tools

Adobe Firefly Services

10 tools

Agorapulse

21 tools

Works well with

Pike13

67 tools

Raisely

61 tools

ServiceM8

61 tools

Givebutter

60 tools

Frequently Asked Questions

How do I connect The Brief to my app?

Use Weavz Hosted Connect for Custom authentication. Install the SDK, create a connection through the connect portal or API, then execute tools programmatically.

What tools does The Brief support?

The Brief supports 79 tools including Create Export With Changes, Create Export, Get Export, Get Creative, List Templates, and more.

Can I use The Brief with AI agents?

Yes. Add The Brief to an MCP server in Tool Mode or Code Mode. Code Mode provides 3 meta-tools with on-demand API discovery so agents can compose stateful workflows without loading every action schema up front.

How do I connect The Brief to ChatGPT or Claude?

Open the Weavz connector setup, sign in, choose a workspace, and add The Brief as an approved app. ChatGPT, Claude, and other remote MCP clients can then call the scoped The Brief tools exposed by that workspace.

Does The Brief work with Claude Code, Cursor, Codex, and local agents?

Yes. Remote and local MCP clients can connect to a Weavz MCP endpoint for the workspace. Local coding agents can also use the Weavz CLI to inspect apps, discover actions, run approved The Brief work, and execute Code Mode workflows from a terminal.

What can I ask an AI agent to do with The Brief?

The Brief exposes 79 tools, including Create Export With Changes, Create Export, Get Export, Get Creative, List Templates, and more. Use Weavz to keep credentials scoped, require approval for sensitive work, and audit what the agent did.

Can The Brief be used in stateful agent workflows?

Yes. Agents can combine The Brief tools with Filesystem, State KV, Human Gates, input partials, and other workspace integrations while keeping execution scoped to the selected workspace or end user.

What authentication does The Brief use?

The Brief uses Custom. Weavz stores credentials securely and uses them for authorized action execution.

How much does the The Brief integration cost?

The The Brief integration is included on all Weavz plans including the free tier with 20,000 actions per month. No credit card required.

What triggers does The Brief support?

The Brief supports 12 triggers including Export Status Changed, Export Completed, Export Failed, Creative Status Changed, Creative Completed, and more.

Connect The Brief in minutes

Get 20,000 free action executions every month. No credit card required.

Get Started Free Browse All Integrations

Name	Description
`create_export_with_changes` Export a template while applying element changes, creating a new generated design.	Export a template while applying element changes, creating a new generated design.
`create_export` Export an existing The Brief design or creative by hash.	Export an existing The Brief design or creative by hash.
`get_export` Get export status, generated creative statuses, and temporary download URLs.	Get export status, generated creative statuses, and temporary download URLs.
`get_creative` Refresh a generated creative status and temporary download URL.	Refresh a generated creative status and temporary download URL.
`list_templates` List templates and optionally filter by project, folder, API-generated status, and search text.	List templates and optionally filter by project, folder, API-generated status, and search text.
`list_designs` List designs that are not templates.	List designs that are not templates.
`delete_template` Delete a template or design by hash. Confirmation must equal DELETE followed by the hash.	Delete a template or design by hash. Confirmation must equal DELETE followed by the hash.
`list_template_elements` List editable elements and current layer values for a template.	List editable elements and current layer values for a template.
`list_template_sizes` List size hashes for a template or design set.	List size hashes for a template or design set.
`list_template_font_variants` List valid FONTVARIANT values for a template text layer.	List valid FONTVARIANT values for a template text layer.
`list_design_fonts` List fonts and variants that can be used with a template or design.	List fonts and variants that can be used with a template or design.
`get_share_link` Get the share link and comments for a template or generated design.	Get the share link and comments for a template or generated design.
`generate_share_link` Generate a share-link preview while applying element changes.	Generate a share-link preview while applying element changes.
`list_projects` List projects available to the API credentials.	List projects available to the API credentials.
`create_project` Create a new project assigned to a brand kit.	Create a new project assigned to a brand kit.
`update_project` Update a project name, assigned brand kit, and editor brand-kit selection behavior.	Update a project name, assigned brand kit, and editor brand-kit selection behavior.
`delete_project` Delete a project. Confirmation must equal DELETE PROJECT followed by the project ID.	Delete a project. Confirmation must equal DELETE PROJECT followed by the project ID.
`list_project_users` List users assigned to a project.	List users assigned to a project.
`add_project_user` Add an existing team user to a project.	Add an existing team user to a project.
`remove_project_user` Remove a user from a project. Confirmation must equal REMOVE USER followed by user ID and project ID.	Remove a user from a project. Confirmation must equal REMOVE USER followed by user ID and project ID.
`list_folders` List project folders at the root or under a parent folder.	List project folders at the root or under a parent folder.
`create_folder` Create a folder inside a project or parent folder.	Create a folder inside a project or parent folder.
`update_folder` Rename a folder.	Rename a folder.
`delete_folder` Delete a folder. Confirmation must equal DELETE FOLDER followed by the folder ID.	Delete a folder. Confirmation must equal DELETE FOLDER followed by the folder ID.
`move_design_to_folder` Move a design to a folder. Use -1 as folder ID to move it to the project root.	Move a design to a folder. Use -1 as folder ID to move it to the project root.
`list_brand_kits` List brand kits available to the API credentials.	List brand kits available to the API credentials.
`create_brand_kit` Create a brand kit with brand metadata, voice, and tone.	Create a brand kit with brand metadata, voice, and tone.
`update_brand_kit` Update a brand kit name and brand metadata.	Update a brand kit name and brand metadata.
`delete_brand_kit` Delete a brand kit. Confirmation must equal DELETE BRANDKIT followed by the brand kit ID.	Delete a brand kit. Confirmation must equal DELETE BRANDKIT followed by the brand kit ID.
`list_brand_kit_assets` List image, video, and audio assets in a brand kit.	List image, video, and audio assets in a brand kit.
`upload_brand_kit_assets` Upload image, video, or audio assets to a brand kit from public direct URLs.	Upload image, video, or audio assets to a brand kit from public direct URLs.
`upload_brand_kit_logos` Upload logo image assets to a brand kit from public direct URLs.	Upload logo image assets to a brand kit from public direct URLs.
`list_brand_kit_fonts` List fonts uploaded to a brand kit.	List fonts uploaded to a brand kit.
`upload_brand_kit_font` Upload a TTF, OTF, or WOFF font file to a brand kit using multipart form data.	Upload a TTF, OTF, or WOFF font file to a brand kit using multipart form data.
`delete_brand_kit_font` Delete a font from a brand kit. Confirmation must equal DELETE FONT followed by the font ID.	Delete a font from a brand kit. Confirmation must equal DELETE FONT followed by the font ID.
`list_brand_kit_logo_folders` List brand kit logo folders in a brand kit.	List brand kit logo folders in a brand kit.
`create_brand_kit_logo_folder` Create a brand kit logo folder.	Create a brand kit logo folder.
`rename_brand_kit_logo_folder` Rename a brand kit logo folder.	Rename a brand kit logo folder.
`delete_brand_kit_logo_folder` Delete a brand kit logo folder. Confirmation must equal DELETE FOLDER followed by the folder ID.	Delete a brand kit logo folder. Confirmation must equal DELETE FOLDER followed by the folder ID.
`list_brand_kit_asset_folders` List brand kit asset folders in a brand kit.	List brand kit asset folders in a brand kit.
`create_brand_kit_asset_folder` Create a brand kit asset folder.	Create a brand kit asset folder.
`rename_brand_kit_asset_folder` Rename a brand kit asset folder.	Rename a brand kit asset folder.
`delete_brand_kit_asset_folder` Delete a brand kit asset folder. Confirmation must equal DELETE FOLDER followed by the folder ID.	Delete a brand kit asset folder. Confirmation must equal DELETE FOLDER followed by the folder ID.
`list_brand_kit_media_folders` List legacy brand-kit media folders.	List legacy brand-kit media folders.
`list_brand_kit_color_palettes` List color palettes for a brand kit.	List color palettes for a brand kit.
`create_brand_kit_color_palette` Create a color palette in a brand kit.	Create a color palette in a brand kit.
`update_brand_kit_color_palette` Update the name and colors for a brand-kit color palette.	Update the name and colors for a brand-kit color palette.
`delete_brand_kit_color_palette` Delete a brand-kit color palette. Confirmation must equal DELETE PALETTE followed by the palette ID.	Delete a brand-kit color palette. Confirmation must equal DELETE PALETTE followed by the palette ID.
`list_brand_templates` List brand templates from one or all brand kits.	List brand templates from one or all brand kits.
`list_brand_template_folders` List brand template folders in a brand kit.	List brand template folders in a brand kit.
`create_brand_template_folder` Create a brand template folder.	Create a brand template folder.
`rename_brand_template_folder` Rename a brand template folder.	Rename a brand template folder.
`delete_brand_template_folder` Delete a brand template folder. Confirmation must equal DELETE FOLDER followed by the folder ID.	Delete a brand template folder. Confirmation must equal DELETE FOLDER followed by the folder ID.
`list_users` List users in the The Brief team.	List users in the The Brief team.
`create_user` Create a new team user.	Create a new team user.
`delete_user` Delete a team user by email. Confirmation must equal DELETE USER followed by the email.	Delete a team user by email. Confirmation must equal DELETE USER followed by the email.
`update_team_user_role` Update a team user role by user ID and role ID.	Update a team user role by user ID and role ID.
`list_team_roles` List team roles available for users.	List team roles available for users.
`list_webhook_action_types` List action type IDs usable when creating team webhooks.	List action type IDs usable when creating team webhooks.
`list_webhooks` List The Brief team webhooks.	List The Brief team webhooks.
`create_webhook` Create a team webhook with selected action type IDs.	Create a team webhook with selected action type IDs.
`update_webhook` Update a team webhook name, URL, and action type IDs.	Update a team webhook name, URL, and action type IDs.
`delete_webhook` Delete a team webhook. Confirmation must equal DELETE WEBHOOK followed by the webhook ID.	Delete a team webhook. Confirmation must equal DELETE WEBHOOK followed by the webhook ID.
`list_ad_networks_for_ad_serving` List ad networks that support ad serving tags.	List ad networks that support ad serving tags.
`list_ad_networks_for_html` List ad networks that support HTML export settings.	List ad networks that support HTML export settings.
`enable_ad_tag` Enable ad serving for a design hash.	Enable ad serving for a design hash.
`disable_ad_tag` Disable ad serving for a design hash. Confirmation must equal DISABLE AD TAG followed by the design hash.	Disable ad serving for a design hash. Confirmation must equal DISABLE AD TAG followed by the design hash.
`update_ad_tag_settings` Update click-tag, target, responsive-scaling, and network settings for ad serving.	Update click-tag, target, responsive-scaling, and network settings for ad serving.
`generate_ad_tag_code` Generate HTML embed code for a design ad tag.	Generate HTML embed code for a design ad tag.
`generate_ad_tag_file` Generate a temporary XLSX or CSV file URL containing ad tag data.	Generate a temporary XLSX or CSV file URL containing ad tag data.
`get_ad_serving_report` Generate an ad-serving analytics report with optional project and network filters.	Generate an ad-serving analytics report with optional project and network filters.
`list_design_versions` List saved versions for a design.	List saved versions for a design.
`create_design_version` Create a named version for a design.	Create a named version for a design.
`update_design_version` Rename a saved design version.	Rename a saved design version.
`restore_design_version` Restore a saved design version. Confirmation must equal RESTORE VERSION followed by the version ID.	Restore a saved design version. Confirmation must equal RESTORE VERSION followed by the version ID.
`get_subscription_info` Get credit balances, plan information, and subscription addons for a team.	Get credit balances, plan information, and subscription addons for a team.
`get_team_consumption_report` Get team credit consumption by user and feature over a date range.	Get team credit consumption by user and feature over a date range.
`list_credit_operations` List available credit operations and their costs.	List available credit operations and their costs.
`custom_api_call` Call another The Brief REST API endpoint under https://api.thebrief.ai/v1.	Call another The Brief REST API endpoint under https://api.thebrief.ai/v1.