API ReferenceCopilots

Export

Beta
Export copilot configurations for backup or migration purposes. **IMPORTANT**: This endpoint requires: - Admin privileges - The 'ai-usage-analytics-log.export' scope on the API key Returns all deployed copilots with their full configuration including model settings, tools, and deployment details. Optional date filters can be applied to narrow down results.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
agentCreatedFromdatetimeOptional

Filter copilots created on or after this datetime (ISO 8601 format).

agentCreatedTodatetimeOptional

Filter copilots created before or on this datetime (ISO 8601 format).

versionCreatedFromdatetimeOptional

Filter copilot versions created on or after this datetime (ISO 8601 format).

versionCreatedTodatetimeOptional

Filter copilot versions created before or on this datetime (ISO 8601 format).

limitintegerOptional
Maximum number of copilots to return. Must be a positive integer with a maximum value of 1000. Defaults to 100.
cursorstringOptional
Cursor for pagination. Use the cursor returned in the previous response to fetch the next page of results. If not provided, returns the first page.

Response

This endpoint returns an object.
datalist of objects
List of exported copilots matching the query filters.
hasMoreboolean
Indicates whether there are more results available for pagination.
nextCursorstring or null
Cursor to use for fetching the next page of results. This is a UUID string. If null or not present, there are no more results.