OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the sendMessage endpoint. The sendMessage endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.

Example0

Create Conversation

Send Message

Copilots

Upload Document URL

Example1

Upload Document Contents

Example2

UploadDocumentFileRequest

Upload Document File

Bulk patch metadata for documents, synced natively by Credal or manual API uploads

Metadata

Document Catalog

Create a collection of related documents with a shared metadata schema that you can search across.

createDocumentCollectionExample

Create Document Collection

Delete a document collection given its ID.

deleteDocumentCollectionExample

Delete Document Collection

List all documents in a document collection.

listDocumentsInCollectionExample

List Documents In Collection

Add a document to a document collection. Credal automatically chunks the document and runs the collection's embeddings model on each chunk.
If you want to chunk the document yourself you can use the addDocumentChunksToCollection endpoint.

addDocumentToCollectionExample

Add Document To Collection

Add the specified document chunks to a document collection. Credal automatically runs the collection's embeddings model on each chunk.

addDocumentChunksToCollectionExample

Add Document Chunks To Collection

Reindex a document in a document collection. Credal automatically deletes the existing chunks, re-chunks the document's latest contents and runs the collection's embeddings model on each chunk.
You can optionally provide new custom metadata for the document.

reindexDocumentInCollectionExample

Reindex Document In Collection

Remove a document from a document collection. The document still exists in the document catalog but will not longer be searchable in
this document collection.

removeDocumentFromCollectionExample

Remove Document From Collection

Document Collections

Admin endpoint to check whether the specified user is authorized to read the specified resource.

Check Resource Authorization For User

Admin endpoint to check whether the specified user is authorized to read the specified set of resources.

Check Bulk Resources Authorization For User

Admin endpoint to list all resources that the specified user is authorized to read. Note this endpoint returns cached results and may not be up-to-date. You can use the checkResourceAuthorizationForUser endpoint with disableCache set to true to get the most up-to-date results.

List Cached Authorized Resources For User

Permissions Service

Search across all documents in a document collection using the document metadata and contents.

searchDocumentCollectionExample

Search Document Collection

Search

Users

ExternalResourceId

ResourceIdentifier

ResourceType

CreateConversationResponse

InsertedAuditLog

MessageBlocked

MessageReply

PolicyTrigger

ResponseChunk

SendAgentMessageResponse

SendMessageResponse

Returned when there is a reply 
fetched from the copilot.


Returned when Credal detects possible 
infosec violations and blocks the message.


DocumentMetadataPatch

The identifier for the resource you want to patch

DocumentMetadataPatchRequest

UploadDocumentResponse

CreateDocumentCollectionResponse

DataType

DistanceMetric

IndexedDocument

ListDocumentCollectionResponse

The list of documents in the document collection.

MetadataField

MetadataSchema

Action

CheckBulkResourcesAuthorizationResponse

CheckResourceAuthorizationResponse

Group

Principal

PrincipalListPage

ResourceAuthorizationResult

ResourceListPage

User

DocumentCollectionSearchOptions

The maximum number of chunks to return. Defaults to 10.

Whether to merge the chunks for a document and just return one result per document. Defaults to false.

The similarity threshold between 0 and 1 for the search results. A higher number leads to fewer but more relevant results.
Defaults to 0.45.

Whether to automatically filter the search results based on the user query and available metadata on the collection. Defaults to false.

Whether to rerank the search results after the initial semantic search query. Defaults to false.

DocumentCollectionSearchResult

Operator

SearchDocumentCollectionResponse

SearchResultChunk

The similarity score between 0 and 1 for the search result. A higher number means the chunk is more relevant to the search query.

1	curl -X POST https://api.credal.ai/api/v0/documentCollections/addDocumentToCollection \
2	-H "Authorization: Bearer <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"documentId": "82e4b12a-6990-45d4-8ebd-85c00e030c24",
6	"documentCollectionId": "82e4b12a-6990-45d4-8ebd-85c00e030c24",
7	"customMetadata": {
8	"customerName": "Credal",
9	"meetingDate": "2023-11-06T23:03:42.056Z"
10	}
11	}'

Getting Started

API Reference

Add Document To Collection

Request