Upload Document Contents

POST/v0/catalog/uploadDocumentContentsUpload Document Contents

Request body

application/json

object

allowedUsersEmailAddressesarray of stringrequired

Users allowed to access the document. Unlike Credal's out of the box connectors which reconcile various permissions models from 3rd party software, for custom uploads the caller is responsible for specifying who can access the document and currently flattening groups if applicable. Documents can also be marked as internal public.

Show child attributes

awaitVectorStoreSyncboolean

Document uploads are eventually consistent by default. If specified `true` the API will wait for the vector store to be updated before returning. This is useful if you want to ensure that the document is immediately searchable after this call returns.

collectionIdstring

If specified, the document will also be added to the provided document collection. This operation is eventually consistent, meaning the document does not immediately start appearing in searches of that collection due to an asynchronous embedding process. To achieve strong consistency use the `awaitVectorStoreSync` parameter.

customMetadataobject

Optional JSON representing any custom metadata for this document

documentContentsstringrequired

The full LLM-formatted text contents of the document you want to upload.

documentExternalIdstringrequired

The external ID of the document. This is typically the ID as it exists in its original external system. Uploads to the same external ID will update the document in Credal.

documentExternalUrlstring

The external URL of the document you want to upload. If provided Credal will link to this URL.

documentNamestringrequired

The name of the document you want to upload.

forceUpdateboolean

If specified, document contents will be re-uploaded and re-embedded even if the document already exists in Credal

internalPublicboolean

If specified, document will be accessible to everyone within the organization of the uploader

uploadAsUserEmailstringrequired

[Legacy] The user on behalf of whom the document should be uploaded. In most cases, this can simply be the email of the developer making the API call. This field will be removed in the future in favor of purely specifying permissions via allowedUsersEmailAddresses.

Example request

{
  "allowedUsersEmailAddresses": [
    "string"
  ],
  "awaitVectorStoreSync": true,
  "collectionId": "string",
  "customMetadata": {
    "additionalProp1": "string"
  },
  "documentContents": "string",
  "documentExternalId": "string",
  "documentExternalUrl": "string",
  "documentName": "string",
  "forceUpdate": true,
  "internalPublic": true,
  "uploadAsUserEmail": "string"
}

Responses

objectdocumentCatalog_UploadDocumentResponse

UploadDocumentResponse

documentIdstring · uuidrequired

Example response

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

Examples

curl -X POST 'https://api.credal.ai/api/v0/catalog/uploadDocumentContents' \
  -H 'Content-Type: application/json' \
  -d '{"allowedUsersEmailAddresses":["string"],"awaitVectorStoreSync":true,"collectionId":"string","customMetadata":{"additionalProp1":"string"},"documentContents":"string","documentExternalId":"string","documentExternalUrl":"string","documentName":"string","forceUpdate":true,"internalPublic":true,"uploadAsUserEmail":"string"}'

const response = await fetch('https://api.credal.ai/api/v0/catalog/uploadDocumentContents', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"allowedUsersEmailAddresses":["string"],"awaitVectorStoreSync":true,"collectionId":"string","customMetadata":{"additionalProp1":"string"},"documentContents":"string","documentExternalId":"string","documentExternalUrl":"string","documentName":"string","forceUpdate":true,"internalPublic":true,"uploadAsUserEmail":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/catalog/uploadDocumentContents', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"allowedUsersEmailAddresses\":[\"string\"],\"awaitVectorStoreSync\":true,\"collectionId\":\"string\",\"customMetadata\":{\"additionalProp1\":\"string\"},\"documentContents\":\"string\",\"documentExternalId\":\"string\",\"documentExternalUrl\":\"string\",\"documentName\":\"string\",\"forceUpdate\":true,\"internalPublic\":true,\"uploadAsUserEmail\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/catalog/uploadDocumentContents",
    headers={"Content-Type": "application/json"},
    data='{"allowedUsersEmailAddresses":["string"],"awaitVectorStoreSync":true,"collectionId":"string","customMetadata":{"additionalProp1":"string"},"documentContents":"string","documentExternalId":"string","documentExternalUrl":"string","documentName":"string","forceUpdate":true,"internalPublic":true,"uploadAsUserEmail":"string"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"allowedUsersEmailAddresses":["string"],"awaitVectorStoreSync":true,"collectionId":"string","customMetadata":{"additionalProp1":"string"},"documentContents":"string","documentExternalId":"string","documentExternalUrl":"string","documentName":"string","forceUpdate":true,"internalPublic":true,"uploadAsUserEmail":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/catalog/uploadDocumentContents", 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/catalog/uploadDocumentContents");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"allowedUsersEmailAddresses\":[\"string\"],\"awaitVectorStoreSync\":true,\"collectionId\":\"string\",\"customMetadata\":{\"additionalProp1\":\"string\"},\"documentContents\":\"string\",\"documentExternalId\":\"string\",\"documentExternalUrl\":\"string\",\"documentName\":\"string\",\"forceUpdate\":true,\"internalPublic\":true,\"uploadAsUserEmail\":\"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/catalog/uploadDocumentContents"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"allowedUsersEmailAddresses\":[\"string\"],\"awaitVectorStoreSync\":true,\"collectionId\":\"string\",\"customMetadata\":{\"additionalProp1\":\"string\"},\"documentContents\":\"string\",\"documentExternalId\":\"string\",\"documentExternalUrl\":\"string\",\"documentName\":\"string\",\"forceUpdate\":true,\"internalPublic\":true,\"uploadAsUserEmail\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/catalog/uploadDocumentContents")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"allowedUsersEmailAddresses\":[\"string\"],\"awaitVectorStoreSync\":true,\"collectionId\":\"string\",\"customMetadata\":{\"additionalProp1\":\"string\"},\"documentContents\":\"string\",\"documentExternalId\":\"string\",\"documentExternalUrl\":\"string\",\"documentName\":\"string\",\"forceUpdate\":true,\"internalPublic\":true,\"uploadAsUserEmail\":\"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/catalog/uploadDocumentContents");
request.Content = new StringContent("{\"allowedUsersEmailAddresses\":[\"string\"],\"awaitVectorStoreSync\":true,\"collectionId\":\"string\",\"customMetadata\":{\"additionalProp1\":\"string\"},\"documentContents\":\"string\",\"documentExternalId\":\"string\",\"documentExternalUrl\":\"string\",\"documentName\":\"string\",\"forceUpdate\":true,\"internalPublic\":true,\"uploadAsUserEmail\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

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

Search documentation

copilots

documentCatalog

documentCollections

search

users