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

Provide Message Feedback

Send Message

Copilots

Example1

Upload Document Contents

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

Metadata

Document Catalog

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.

addDocumentsToCollectionExample

Add Documents To 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

FeedbackEnum

InsertedAuditLog

MessageBlocked

MessageFeedback

MessageReply

PolicyTrigger

ReferencedSource

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

Action

AuthorizedResource

AuthorizedResourceListPage

CheckBulkResourcesAuthorizationResponse

CheckResourceAuthorizationResponse

Group

Principal

PrincipalListPage

ResourceAuthorizationResult

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 PATCH https://api.credal.ai/api/v0/users/metadata \
2	-H "Authorization: Bearer <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '[
5	{
6	"userEmail": "ravin@credal.ai",
7	"metadata": {
8	"State": "NY",
9	"Job Role": "CEO"
10	}
11	},
12	{
13	"userEmail": "jack@credal.ai",
14	"metadata": {
15	"State": "NY",
16	"Department": "Engineering"
17	}
18	}
19	]'