AI

Update AI copilot

Changed on

This endpoint updates an existing AI copilot's configuration. Corresponds to liveblocks.updateAiCopilot.

This endpoint returns a 422 response if the update doesn't apply due to validation failures. For example, if the existing copilot uses the "openai" provider and you attempt to update the provider model to an incompatible value for the provider, like "gemini-2.5-pro", you'll receive a 422 response with an error message explaining where the validation failed.

post/ai/copilots/{copilotId}

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/ai/copilots/{copilotId}
  • Auth: none declared

Path parameters

copilotIdstring required

ID of the AI copilot

Example:cp_abc123

Request body

namestring
descriptionstring nullable
systemPromptstring
knowledgePromptstring nullable
alwaysUseKnowledgeboolean
providerApiKeystring
provider'openai' | 'anthropic' | 'google' | 'openai-compatible'
providerModelstring
compatibleProviderNamestring
providerBaseUrlstring uri

Example request

{
  "name": "Updated Copilot",
  "systemPrompt": "You are an updated helpful assistant.",
  "providerModel": "gpt-4o",
  "settings": {
    "maxTokens": 8192
  }
}

Response

Success. Returns the updated AI copilot.

OR
OR
OR

Example response

{
  "type": "copilot",
  "id": "cp_abc123",
  "name": "My Copilot",
  "systemPrompt": "You are a helpful assistant.",
  "alwaysUseKnowledge": true,
  "createdAt": "2024-06-01T12:00:00.000Z",
  "updatedAt": "2024-06-01T12:00:00.000Z",
  "provider": "openai",
  "providerModel": "gpt-4o",
  "settings": {
    "maxTokens": 4096,
    "temperature": 0.7
  }
}

Changes

  • ac92172e715eRevision changes
    • warning

      added the new claude-opus-4-5-20251101 enum value to the // response property for the response status

    • warning

      added the new claude-opus-4-6 enum value to the // response property for the response status

    • warning

      added the new claude-opus-4-7 enum value to the // response property for the response status

    • warning

      added the new claude-sonnet-4-6 enum value to the // response property for the response status

    • warning

      added the new gemini-3-flash-preview enum value to the // response property for the response status

    • warning

      added the new gemini-3.1-pro-preview enum value to the // response property for the response status

    • warning

      added the new gpt-5-pro enum value to the // response property for the response status

    • warning

      added the new gpt-5.2 enum value to the // response property for the response status

    • warning

      added the new gpt-5.2-pro enum value to the // response property for the response status

    • warning

      added the new gpt-5.4 enum value to the // response property for the response status

    • warning

      added the new gpt-5.4-mini enum value to the // response property for the response status

    • warning

      added the new gpt-5.4-nano enum value to the // response property for the response status

    • warning

      added the new gpt-5.4-pro enum value to the // response property for the response status

    • warning

      added the new gpt-5.5 enum value to the // response property for the response status

  • 77cd6a75b2b7Revision changes
    • breaking

      request body became required

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      removed subschema #1 subschema #2 subschema #3 from the request property oneOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      added to the response body oneOf list for the response status

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added subschema #2 to the request property oneOf list

    • info

      added subschema #4 to the request property oneOf list

    • info

      added openai anthropic google openai-compatible mapping keys to the response discriminator for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the response body oneOf list for the response status