Export

POST/v0/copilots/exportExport

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.

Request body

application/json

object

agentCreatedFromstring · date-time

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

agentCreatedTostring · date-time

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

cursorstring

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.

limitinteger

Maximum number of copilots to return. Must be a positive integer with a maximum value of 1000. Defaults to 100.

versionCreatedFromstring · date-time

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

versionCreatedTostring · date-time

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

Example request

{
  "agentCreatedFrom": "2026-06-09T00:00:00Z",
  "agentCreatedTo": "2026-06-09T00:00:00Z",
  "cursor": "string",
  "limit": 0,
  "versionCreatedFrom": "2026-06-09T00:00:00Z",
  "versionCreatedTo": "2026-06-09T00:00:00Z"
}

Responses

objectcopilots_ExportCopilotsResponse

ExportCopilotsResponse

dataarray of objectrequired

List of exported copilots matching the query filters.

Show child attributes

Show array items

agentCreatedDatetimestring · date-timerequired

ISO 8601 timestamp when the copilot was originally created.

aiEndpointConfigurationvaluerequired

AI endpoint configuration including base URL and authentication details.

deploymentConfigurationvaluerequired

Deployment settings and configuration.

descriptionstringrequired

The description of the deployed copilot version.

idstring · uuidrequired

The unique identifier of the copilot.

inputsvaluerequired

Input variable configurations for the copilot.

isDeployedbooleanrequired

Indicates if the copilot is currently deployed (always true for export results).

modelConfigurationvaluerequired

Model configuration including provider, model name, temperature, and other settings.

namestringrequired

The name of the deployed copilot version.

toolConfigurationsvaluerequired

List of tool configurations available to the copilot.

versionCreatedDatetimestring · date-timerequired

ISO 8601 timestamp when the deployed version was created.

hasMorebooleanrequired

Indicates whether there are more results available for pagination.

nextCursorstring

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.

Example response

{
  "data": [
    {
      "agentCreatedDatetime": "2026-06-09T00:00:00Z",
      "aiEndpointConfiguration": null,
      "deploymentConfiguration": null,
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "inputs": null,
      "isDeployed": true,
      "modelConfiguration": null,
      "name": "string",
      "toolConfigurations": null,
      "versionCreatedDatetime": "2026-06-09T00:00:00Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "string"
}

Examples

curl -X POST 'https://api.credal.ai/api/v0/copilots/export' \
  -H 'Content-Type: application/json' \
  -d '{"agentCreatedFrom":"2026-06-09T00:00:00Z","agentCreatedTo":"2026-06-09T00:00:00Z","cursor":"string","limit":0,"versionCreatedFrom":"2026-06-09T00:00:00Z","versionCreatedTo":"2026-06-09T00:00:00Z"}'

const response = await fetch('https://api.credal.ai/api/v0/copilots/export', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"agentCreatedFrom":"2026-06-09T00:00:00Z","agentCreatedTo":"2026-06-09T00:00:00Z","cursor":"string","limit":0,"versionCreatedFrom":"2026-06-09T00:00:00Z","versionCreatedTo":"2026-06-09T00:00:00Z"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/copilots/export', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"agentCreatedFrom\":\"2026-06-09T00:00:00Z\",\"agentCreatedTo\":\"2026-06-09T00:00:00Z\",\"cursor\":\"string\",\"limit\":0,\"versionCreatedFrom\":\"2026-06-09T00:00:00Z\",\"versionCreatedTo\":\"2026-06-09T00:00:00Z\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/copilots/export",
    headers={"Content-Type": "application/json"},
    data='{"agentCreatedFrom":"2026-06-09T00:00:00Z","agentCreatedTo":"2026-06-09T00:00:00Z","cursor":"string","limit":0,"versionCreatedFrom":"2026-06-09T00:00:00Z","versionCreatedTo":"2026-06-09T00:00:00Z"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"agentCreatedFrom":"2026-06-09T00:00:00Z","agentCreatedTo":"2026-06-09T00:00:00Z","cursor":"string","limit":0,"versionCreatedFrom":"2026-06-09T00:00:00Z","versionCreatedTo":"2026-06-09T00:00:00Z"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/copilots/export", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.credal.ai/api/v0/copilots/export");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"agentCreatedFrom\":\"2026-06-09T00:00:00Z\",\"agentCreatedTo\":\"2026-06-09T00:00:00Z\",\"cursor\":\"string\",\"limit\":0,\"versionCreatedFrom\":\"2026-06-09T00:00:00Z\",\"versionCreatedTo\":\"2026-06-09T00:00:00Z\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.credal.ai/api/v0/copilots/export"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"agentCreatedFrom\":\"2026-06-09T00:00:00Z\",\"agentCreatedTo\":\"2026-06-09T00:00:00Z\",\"cursor\":\"string\",\"limit\":0,\"versionCreatedFrom\":\"2026-06-09T00:00:00Z\",\"versionCreatedTo\":\"2026-06-09T00:00:00Z\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/copilots/export")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"agentCreatedFrom\":\"2026-06-09T00:00:00Z\",\"agentCreatedTo\":\"2026-06-09T00:00:00Z\",\"cursor\":\"string\",\"limit\":0,\"versionCreatedFrom\":\"2026-06-09T00:00:00Z\",\"versionCreatedTo\":\"2026-06-09T00:00:00Z\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.credal.ai/api/v0/copilots/export");
request.Content = new StringContent("{\"agentCreatedFrom\":\"2026-06-09T00:00:00Z\",\"agentCreatedTo\":\"2026-06-09T00:00:00Z\",\"cursor\":\"string\",\"limit\":0,\"versionCreatedFrom\":\"2026-06-09T00:00:00Z\",\"versionCreatedTo\":\"2026-06-09T00:00:00Z\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "agentCreatedDatetime": "2026-06-09T00:00:00Z",
      "aiEndpointConfiguration": null,
      "deploymentConfiguration": null,
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "inputs": null,
      "isDeployed": true,
      "modelConfiguration": null,
      "name": "string",
      "toolConfigurations": null,
      "versionCreatedDatetime": "2026-06-09T00:00:00Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "string"
}

Search documentation

copilots

documentCatalog

documentCollections

search

users