Actions83
- AI Copilot Actions
- AI Knowledge Actions
- Attachment Actions
- Comment Actions
- Feed Actions
- Group Actions
- Inbox Actions
- Room Actions
- Storage Actions
- Thread Actions
- User Actions
- Delete Inbox Notification
- Get Inbox Notification
- Delete All Inbox Notifications
- Get Many Inbox Notifications
- Delete Notification Settings
- Get Notification Settings
- Update Notification Settings
- Delete Room Subscription Settings
- Get Room Subscription Settings
- Update Room Subscription Settings
- Get Many Room Subscription Settings
- Yjs Actions
AI Copilot → Update
AI-generatedSummary
Update an existing AI Copilot configuration in Liveblocks by specifying its Copilot ID and providing optional new values for its attributes such as name, description, prompts, provider details, and settings.
Inputs
- Copilot ID (required) — The unique identifier of the AI Copilot to update.
- Name — New name for the AI Copilot.
- Description — New description for the AI Copilot.
- System Prompt — Updated system prompt to guide the AI Copilot's behavior.
- Knowledge Prompt — Updated knowledge prompt providing context or background for the AI Copilot.
- Always Use Knowledge — Boolean flag to enforce the AI Copilot always uses its knowledge base.
- Provider API Key — API key for the AI provider used by the copilot, kept secure.
- Provider — The AI provider service to use, e.g., OpenAI, Anthropic, or Google.
- Provider Model — Specific AI model to use from the chosen provider.
- Compatible Provider Name — Name for OpenAI Compatible providers if applicable.
- Provider Base URL — Custom base URL endpoint for the AI provider's API.
- Provider Settings — Additional provider-specific settings in JSON format.
- Provider Options — Extra options for the provider configuration in JSON format.
- Include Request in Error — If enabled, includes request details in error messages for debugging.
Output shape
a single record
Returns the updated AI Copilot object reflecting the applied changes. Errors include optional detailed request information if enabled.
Examples
Example 1: Update AI Copilot name and model
Specify a Copilot ID with new name and provider model, leaving other fields unchanged.