AI

Get AI copilots

Changed on

This endpoint returns a paginated list of AI copilots. The copilots are returned sorted by creation date, from newest to oldest. Corresponds to liveblocks.getAiCopilots.

get/ai/copilots

Request

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

Query parameters

limitinteger

A limit on the number of copilots to be returned. The limit can range between 1 and 100, and defaults to 20.

Example:20
startingAfterstring

A cursor used for pagination. Get the value from the nextCursor response of the previous page.

Example:eyJjcmVhdGVkQXQiOjE2NjAwMDA5ODgxMzd9

Response

Success. Returns the list of AI copilots.

nextCursorstring nullable required

Example response

{
  "nextCursor": null,
  "data": [
    {
      "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"
    }
  ]
}

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

      for the query request parameter limit, the type changed from number to integer

    • breaking

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

    • breaking

      added to the / response property oneOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

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

    • info

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