For the complete documentation index, see llms.txt. This page is also available as Markdown.

Flow Document Collections

List a group's document collections.

get

Returns a skip/take paged list of the document collections in a flow group, with the total count.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowGroupObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Query parameters
skipinteger · int32OptionalDefault: 0
takeinteger · int32OptionalDefault: 50
Responses
200

OK

totalCountinteger · int32Optional
skipinteger · int32Optional
takeinteger · int32Optional
get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections

Create a flow document collection.

post

Creates a document collection in a flow group and attaches any supplied documents, queuing them for extraction.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowGroupObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
namestring · nullableRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
namestring · nullableOptional
dateAddedstring · date-timeOptional
hasActiveAssignmentbooleanOptional
post/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections

Bulk-create flow document collections.

post

Creates a collection for each supplied document in the flow group in a single request.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowGroupObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
documentObjectIdentifiersstring · uuid[] · nullableOptional
Responses
204

No Content

No content

post/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/bulk

No content

Get a flow document collection.

get

Returns the full detail of a single document collection identified by its GUID.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowGroupObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
namestring · nullableOptional
dateAddedstring · date-timeOptional
hasActiveAssignmentbooleanOptional
get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{objectIdentifier}

Delete a flow document collection.

delete

Deletes a document collection unless a flow run is currently in progress for it.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowGroupObjectIdentifierstringRequired
Responses
204

No Content

No content

delete/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{objectIdentifier}

No content

Search flow document collections.

post

Returns a paginated, filtered and sorted list of document collections within a flow group.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowGroupObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
logicOperatorstring · enumOptionalPossible values:
pageinteger · int32Optional
pageSizeinteger · int32Optional
searchTextstring · nullableOptional
sortBystring · nullableOptional
sortAscboolean · nullableOptional
documentObjectIdentifiersToSearchstring · uuid[] · nullableOptional
promptObjectIdentifiersToIncludestring · uuid[] · nullableOptional
assignedToResourceOwnerIdsstring[] · nullableOptional
reviewedByResourceOwnerIdsstring[] · nullableOptional
Responses
200

OK

totalCountinteger · int32Optional
pageinteger · int32Optional
pageSizeinteger · int32Optional
post/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/search

Locate a collection's page and row.

post

Finds the page and row index of a prompt answer within the given search, filter and sort context.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowGroupObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
promptAnswerObjectIdentifierstring · uuidOptional
pageSizeinteger · int32Optional
logicOperatorstring · enumOptionalPossible values:
searchTextstring · nullableOptional
sortBystring · nullableOptional
sortAscboolean · nullableOptional
Responses
200

OK

foundbooleanOptional
pageinteger · int32 · nullableOptional
rowIndexinteger · int32 · nullableOptional
reasonstring · nullableOptional
post/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/locate

Count a group's document collections.

get

Returns the total number of document collections in the specified flow group.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowGroupObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Responses
200

OK

integer · int32Optional
get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/count

Add documents to a collection.

post

Attaches additional documents to an existing collection and queues them for extraction.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
collectionObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowGroupObjectIdentifierstringRequired
Body
documentObjectIdentifiersstring · uuid[] · nullableOptional
Responses
200

OK

objectIdentifierstring · uuidOptional
flowDocumentCollectionObjectIdentifierstring · uuidOptional
documentsAssignedinteger · int32Optional
createdAtUtcstring · date-timeOptional
post/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/assignments

List a collection's tags.

get

Returns the manual key/value tags applied to a document collection.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
collectionObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowGroupObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
keystring · nullableOptional
valuestring · nullableOptional
get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/tags

Set a collection tag.

put

Adds or updates a manual key/value tag on a document collection.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
collectionObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowGroupObjectIdentifierstringRequired
Body
keystring · nullableRequired
valuestring · nullableRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
keystring · nullableOptional
valuestring · nullableOptional
put/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/tags

List the flow's tag vocabulary.

get

Returns every distinct key/value tag used across the owning flow's collections.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowGroupObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
keystring · nullableOptional
valuestring · nullableOptional
get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/tags

Remove a collection tag.

delete

Removes a manual key/value tag from a document collection.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
collectionObjectIdentifierstring · uuidRequired
tagObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowGroupObjectIdentifierstringRequired
Responses
204

No Content

No content

delete/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/tags/{tagObjectIdentifier}

No content

Last updated