Add Documents To Collection

POST/v0/documentCollections/addDocumentsToCollectionAdd Documents To Collection

Add documents to a document collection. Note that the documents must already exist in the document catalog to use this endpoint. If you want to upload a new document to a collection, use the uploadDocumentContents endpoint.

Request body

application/json

object

collectionIdstring · uuidrequired

The ID of the document collection you want to add to.

resourceIdentifiersarray of valuerequired

The set of resource identifier for which you want to add to the collection.

Show child attributes

Show array items

oneOf · 2 options

Option 1object

externalResourceIdstringrequired

resourceTypestringrequired

one of "GOOGLE_DRIVE_ITEM", "MICROSOFT_DRIVE_ITEM", "ZENDESK_TICKET", "ZENDESK_ARTICLE", "ZENDESK_GROUP", "ZENDESK_ARTICLE_SECTION", "ZENDESK_ARTICLE_CATEGORY", "CONFLUENCE_PAGE", "CONFLUENCE_SPACE", "JIRA_TICKET", "JIRA_PROJECT", "SALESFORCE_TASK", "BOX_FILE", "BOX_FOLDER", "NOTION_PAGE", "NOTION_DATABASE", "SLACK_CHANNEL", "MONGO_COLLECTION_SYNC", "UNKNOWN"

typestringrequired

Discriminator value: external-resource-id

one of "external-resource-id"

Option 2object

typestringrequired

Discriminator value: url

one of "url"

urlstringrequired

Example request

{
  "collectionId": "00000000-0000-0000-0000-000000000000",
  "resourceIdentifiers": [
    {
      "externalResourceId": "string",
      "resourceType": "BOX_FILE",
      "type": "external-resource-id"
    }
  ]
}

Responses

Examples

curl -X POST 'https://api.credal.ai/api/v0/documentCollections/addDocumentsToCollection' \
  -H 'Content-Type: application/json' \
  -d '{"collectionId":"00000000-0000-0000-0000-000000000000","resourceIdentifiers":[{"externalResourceId":"string","resourceType":"BOX_FILE","type":"external-resource-id"}]}'

const response = await fetch('https://api.credal.ai/api/v0/documentCollections/addDocumentsToCollection', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"collectionId":"00000000-0000-0000-0000-000000000000","resourceIdentifiers":[{"externalResourceId":"string","resourceType":"BOX_FILE","type":"external-resource-id"}]}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/documentCollections/addDocumentsToCollection', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"resourceIdentifiers\":[{\"externalResourceId\":\"string\",\"resourceType\":\"BOX_FILE\",\"type\":\"external-resource-id\"}]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/documentCollections/addDocumentsToCollection",
    headers={"Content-Type": "application/json"},
    data='{"collectionId":"00000000-0000-0000-0000-000000000000","resourceIdentifiers":[{"externalResourceId":"string","resourceType":"BOX_FILE","type":"external-resource-id"}]}',
)
print(response.json())

package main

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

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

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/documentCollections/addDocumentsToCollection")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"resourceIdentifiers\":[{\"externalResourceId\":\"string\",\"resourceType\":\"BOX_FILE\",\"type\":\"external-resource-id\"}]}"
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/addDocumentsToCollection");
request.Content = new StringContent("{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"resourceIdentifiers\":[{\"externalResourceId\":\"string\",\"resourceType\":\"BOX_FILE\",\"type\":\"external-resource-id\"}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 200)

Search documentation

copilots

documentCatalog

documentCollections

search

users