Content APIs¶
Get Content By ID¶
This API returns the content requested.
| Method | GET |
| Endpoint | <host_url>/api/public/bot/:botId/content/contentId |
| Content-Type | application/json |
| Authorization | auth: <JWT Token> |
| API Scope | Document Management |
Query Parameters¶
| Parameters | Description | Mandatory |
| Bot ID | Provide your application ID here. | Yes |
| ContentID | Unique ID of the content to be retrieved. This is returned as doc_id in the response of the advancedSearch API. You can also find this identifier in the Chunk Browser labeled as "docId" or in the JSON view of the ingested content, where it appears as "_id." | Yes |
Sample Response¶
{
"_id": "fc-26d474d1-2aa7-50cf-984d-e719a4884792",
"searchIndexId": "sidx-cdd15c7a-47d5-5839-80ee-e4f418489f70",
"streamId": "st-7561b874-2114-5b8f-8086-ea69007b5f53",
"createdBy": "u-4d04030a-93f3-5cba-a07b-1a5b20a7e9a9",
"createdOn": "2024-03-06T12:08:39.719Z",
"lMod": "2024-11-18T07:33:35.000Z",
"extractionType": "jira",
"extractionSourceId": "fs-5c651c22-eb9f-5bb7-ad51-84de1df15639",
"jobId": "fj-fecfb47b-eea8-5419-aadb-ad8552c0a7e5",
"_source": {
"meta_data": {
"assignee": "John",
"projectId": "10000",
"issueType": "Task",
"projectName": "Searchassist_Test",
"issueStatus": "To Do",
"comments": " Continue Working on it.. Give the Latest Update ",
"reporter": "Jacob",
"ticketId": "ST-2"
},
"sys_racl": [
"10000"
],
"sys_content_type": "jira",
"sys_source_name": "Jira COnnector",
"sourceType": "jira",
"raw_data": "...",
"base_url": "",
"title": "Debugging Request: UXO Stagging -testing",
"content": "Debugging Request: UXO Stagging -testing Request for debugging in the UXO Staging\nAssignee: John\nProject ID: 10000\nIssue Type: Task\nProject Name: Searchassist_Test\nIssue Status: To Do\nReporter: Jacob\nComments: Continue Working on it.. Give the Latest Update ",
"url": "https://searchassistjira.atlassian.net/browse/xx-2",
"type": "Task",
"comments": " Please Update the status."
},
"connectorId": "fcon-c13cc009-be5f-50d8-b903-941f88f7b3b7",
"externalSourceId": "sidx-cdd15c7a-47d5-5839-80ee-e4f418489f70_ST-2",
"updatedOn": "2024-09-09T10:32:27.394Z",
"__v": 0
}
Delete Content¶
This API deletes specific content from the SearchAI application. Deleting the content also deletes the corresponding chunks from the application.
| Method | DELETE |
| Endpoint | <host_url>/api/public/bot/:botId/content |
| Content-Type | application/json |
| Authorization | auth: <JWT Token> |
| API Scope | Document Management |
Query Parameters¶
| Parameters | Description | Mandatory |
| Bot ID | Provide your application ID here. | Yes |
Request Parameters¶
| Parameters | Description | Mandatory |
| docIDs | Array of identifiers of the records to be deleted from the application. Please note that this id is available as doc_id and starts with “d-”.Use this field for structured data/chunks. | Yes |
Sample Request
Response Parameters¶
| Parameters | Description |
deletedCount
|
Count of the number of records deleted successfully. |
Get Content by Condition¶
This API is used to fetch specific content from the SearchAI application based on a given condition.
| Method | POST |
| Endpoint | <host_url>/api/public/bot/:botId/content-by-cond |
| Content-Type | application/json |
| Authorization | auth: <JWT Token> |
| API Scope | Document Management |
Query Parameters¶
| Parameters | Description | Mandatory |
| Bot ID | Provide your application ID here. | Yes |
Request Parameters¶
| Parameters | Description | Mandatory |
| query | This contains all the fields on which filters are to be applied. It can have one or more fields. If there are more than one fields, a logical AND operation is performed on the results produced by the filters.
For example, if
}, all the file type of content is returned in the response. Similarly, if
}, all the files with title equal to ‘my file’ are returned in the response. |
Yes |
| nextCursor | This field is used for cursor based pagination. The first time API request is made without this field. It returns the first set of data. The response of the API includes a cursor value that should be passed in the next request. The cursor identifies a specific item in the dataset, which serves as the starting point for the next page of results. Use the cursor value as provided in the previous response object. When the field nextCursor set as null, it indicates the end of resultset. | No |
Sample Request¶
{
"query": { //title and sys_content_type fields
"title": "title name",
"sys_content_type": "file",
},
"nextCursor": "2024-10-04T13:38:47.762Z"
}