Add Collection To Copilot

POST/v0/copilots/addCollectionToCopilotAdd Collection To Copilot

Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.

Request body

application/json

object

collectionIdstring · uuidrequired

Credal-generated collection ID to add.

copilotIdstring · uuidrequired

Credal-generated Agent ID to add the collection to.

Example request

{
  "collectionId": "00000000-0000-0000-0000-000000000000",
  "copilotId": "00000000-0000-0000-0000-000000000000"
}

Responses

Examples

curl -X POST 'https://api.credal.ai/api/v0/copilots/addCollectionToCopilot' \
  -H 'Content-Type: application/json' \
  -d '{"collectionId":"00000000-0000-0000-0000-000000000000","copilotId":"00000000-0000-0000-0000-000000000000"}'

const response = await fetch('https://api.credal.ai/api/v0/copilots/addCollectionToCopilot', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"collectionId":"00000000-0000-0000-0000-000000000000","copilotId":"00000000-0000-0000-0000-000000000000"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/copilots/addCollectionToCopilot', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/copilots/addCollectionToCopilot",
    headers={"Content-Type": "application/json"},
    data='{"collectionId":"00000000-0000-0000-0000-000000000000","copilotId":"00000000-0000-0000-0000-000000000000"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"collectionId":"00000000-0000-0000-0000-000000000000","copilotId":"00000000-0000-0000-0000-000000000000"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/copilots/addCollectionToCopilot", 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/addCollectionToCopilot");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\"}");
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/addCollectionToCopilot"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/copilots/addCollectionToCopilot")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\"}"
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/addCollectionToCopilot");
request.Content = new StringContent("{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 200)

Search documentation

copilots

documentCatalog

documentCollections

search

users