Search

Search Document Catalog

POST
Search across all documents uploaded to Credal using the document metadata and contents.

Request

This endpoint expects an object.
searchQuery
stringRequired
searchOptions
objectOptional

Response

This endpoint returns an object
searchId
UUID
results
list of objects
POST
$curl -X POST https://api.credal.ai/api/v0/search/searchDocumentCatalog \
> -H "Authorization: Bearer <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "searchQuery": "ABC Corp",
> "searchOptions": {
> "maxResults": 5
> }
>}'
Response
1{
2 "searchId": "76b4cdda-5d5c-11ee-b268-cb249f5be4f9",
3 "results": [
4 {
5 "documentId": "82e4b12a-6990-45d4-8ebd-85c00e030c24",
6 "documentName": "ABC Corp - Initial meeting transcript"
7 },
8 {
9 "documentId": "c7e1283b-4f66-4caf-828d-cf03841e0324",
10 "documentName": "ABC Corp - Demo meeting transcript"
11 }
12 ]
13}