Flow Documents
Retrieves a paginated list of flow documents for the specified flow, optionally filtered and sorted.
Bearer authentication with JWT
The unique identifier of the flow.
The page number to retrieve.
The number of items per page.
Optional search text to filter flow documents.
The sorting option for the results.
Whether to sort in descending order.
trueOK
No content
Forbidden
GET /projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Adds a range of documents to the specified flow.
Bearer authentication with JWT
The unique identifier of the flow.
OK
No content
Bad Request
Forbidden
POST /projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
[
"123e4567-e89b-12d3-a456-426614174000"
]No content
Removes a range of documents from the specified flow.
Bearer authentication with JWT
The unique identifier of the flow.
The collection of document object identifiers to remove.
No Content
Forbidden
Not Found
DELETE /projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Searches for flow documents in the specified flow using filter criteria.
Bearer authentication with JWT
The unique identifier of the flow.
OK
No content
Bad Request
Forbidden
POST /projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents/search HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 351
{
"searchText": "text",
"pageNumber": 1,
"pageSize": 1,
"sortBy": "text",
"sortAsc": true,
"promptColumns": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"promptSearches": {
"ANY_ADDITIONAL_PROPERTY": {
"isYes": true,
"minimumValue": 1,
"maximumValue": 1,
"categoryIdentifiers": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
},
"documentsToSearch": [
"123e4567-e89b-12d3-a456-426614174000"
]
}No content
Retrieves a flow document by its document identifier.
Bearer authentication with JWT
The unique identifier of the flow.
The unique identifier of the document.
OK
No content
Forbidden
Not Found
GET /projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents/{documentIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Moves documents within the specified flow to a different folder.
Bearer authentication with JWT
The unique identifier of the flow.
No Content
Bad Request
Forbidden
Not Found
POST /projects/{projectIdentifier}/flows/{flowIdentifier}/flow-documents/move-documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 216
{
"folderIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"promptSearches": {
"ANY_ADDITIONAL_PROPERTY": {
"isYes": true,
"minimumValue": 1,
"maximumValue": 1,
"categoryIdentifiers": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
}
}No content
Last updated