Create Collection

POST/v0/documentCollections/createCollectionCreate Collection

Create a new collection. The API key used will be added to the collection for future Requests

Request body

application/json

object

collaboratorsarray of objectrequired

A list of collaborator emails and roles that will have access to the agent.

Show child attributes

Show array items

emailstringrequired

rolestringrequired

one of "viewer", "editor"

descriptionstringrequired

An in depth name for the agent's function. Useful for routing requests to the right agent.

namestringrequired

A descriptive name for the collection.

Example request

{
  "collaborators": [
    {
      "email": "string",
      "role": "editor"
    }
  ],
  "description": "string",
  "name": "string"
}

Responses

objectdocumentCollections_CreateCollectionResponse

CreateCollectionResponse

collectionIdstring · uuidrequired

Example response

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

Examples

curl -X POST 'https://api.credal.ai/api/v0/documentCollections/createCollection' \
  -H 'Content-Type: application/json' \
  -d '{"collaborators":[{"email":"string","role":"editor"}],"description":"string","name":"string"}'

const response = await fetch('https://api.credal.ai/api/v0/documentCollections/createCollection', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"collaborators":[{"email":"string","role":"editor"}],"description":"string","name":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/documentCollections/createCollection', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"collaborators\":[{\"email\":\"string\",\"role\":\"editor\"}],\"description\":\"string\",\"name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/documentCollections/createCollection",
    headers={"Content-Type": "application/json"},
    data='{"collaborators":[{"email":"string","role":"editor"}],"description":"string","name":"string"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"collaborators":[{"email":"string","role":"editor"}],"description":"string","name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/documentCollections/createCollection", 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/documentCollections/createCollection");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"collaborators\":[{\"email\":\"string\",\"role\":\"editor\"}],\"description\":\"string\",\"name\":\"string\"}");
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/documentCollections/createCollection"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"collaborators\":[{\"email\":\"string\",\"role\":\"editor\"}],\"description\":\"string\",\"name\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/documentCollections/createCollection")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"collaborators\":[{\"email\":\"string\",\"role\":\"editor\"}],\"description\":\"string\",\"name\":\"string\"}"
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/documentCollections/createCollection");
request.Content = new StringContent("{\"collaborators\":[{\"email\":\"string\",\"role\":\"editor\"}],\"description\":\"string\",\"name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

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

Search documentation

copilots

documentCatalog

documentCollections

search

users