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

totalCountinteger · int32Optional

skipinteger · int32Optional

takeinteger · int32Optional

401

Unauthorized

403

Forbidden

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "skip": 1,
  "take": 1,
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "hasActiveAssignment": true
    }
  ]
}

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

objectIdentifierstring · uuidOptional

namestring · nullableOptional

dateAddedstring · date-timeOptional

hasActiveAssignmentbooleanOptional

401

Unauthorized

403

Forbidden

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

POST /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "name": "text",
  "assignments": [
    {
      "documentObjectIdentifiers": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "hasActiveAssignment": true
}

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

401

Unauthorized

403

Forbidden

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

POST /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/bulk HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

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

objectIdentifierstring · uuidOptional

namestring · nullableOptional

dateAddedstring · date-timeOptional

hasActiveAssignmentbooleanOptional

401

Unauthorized

403

Forbidden

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

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "hasActiveAssignment": true
}

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

401

Unauthorized

403

Forbidden

409

Conflict

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

DELETE /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

totalCountinteger · int32Optional

pageinteger · int32Optional

pageSizeinteger · int32Optional

400

Bad Request

401

Unauthorized

403

Forbidden

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

POST /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/search HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 622

{
  "filters": [
    {
      "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "operator": "is",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "logicOperator": "and",
  "columnFilters": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "tagFilters": [
    {
      "key": "text",
      "values": [
        "text"
      ]
    }
  ],
  "folderFilters": [
    {
      "operator": "is",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "page": 1,
  "pageSize": 1,
  "searchText": "text",
  "sortBy": "text",
  "sortAsc": true,
  "documentObjectIdentifiersToSearch": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "promptObjectIdentifiersToInclude": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "assignedToResourceOwnerIds": [
    "text"
  ],
  "reviewedByResourceOwnerIds": [
    "text"
  ]
}

{
  "totalCount": 1,
  "page": 1,
  "pageSize": 1,
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "documents": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "contentType": "text",
          "extension": "text",
          "size": 1,
          "dateAdded": "2026-01-01T00:00:00.000Z",
          "fileType": "unknown",
          "tokenCount": 1,
          "pageCount": 1,
          "convertedToPdf": true,
          "flowDocumentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "folder": "text",
          "filePath": "text"
        }
      ],
      "promptAnswers": {
        "ANY_ADDITIONAL_PROPERTY": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "booleanAnswer": true,
          "textAnswer": "text",
          "decimalAnswer": 1,
          "dateAnswer": "2026-01-01T00:00:00.000Z",
          "approved": true,
          "assignedTo": "text",
          "reviewedBy": "text",
          "assignedToMember": {
            "id": "text",
            "name": "text",
            "email": "text"
          },
          "reviewedByMember": {
            "id": "text",
            "name": "text",
            "email": "text"
          },
          "failedToAnswer": true,
          "categories": [
            {
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "promptCategoryObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "colour": "primary"
            }
          ]
        }
      },
      "approvedCount": 1,
      "rejectedCount": 1,
      "awaitVerificationCount": 1,
      "hasActiveAssignment": true,
      "tags": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "key": "text",
          "value": "text"
        }
      ],
      "throttledPrompts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "promptSkips": {
        "ANY_ADDITIONAL_PROPERTY": {
          "reason": "none",
          "detail": "text",
          "operator": "text",
          "clauses": [
            {
              "predicate": "text",
              "condition": "text",
              "actual": "text",
              "expectedValues": [
                "text"
              ],
              "actualValues": [
                "text"
              ]
            }
          ]
        }
      }
    }
  ]
}

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

foundbooleanOptional

pageinteger · int32 · nullableOptional

rowIndexinteger · int32 · nullableOptional

reasonstring · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

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

POST /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/locate HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 454

{
  "promptAnswerObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "pageSize": 1,
  "filters": [
    {
      "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "operator": "is",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "logicOperator": "and",
  "columnFilters": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "tagFilters": [
    {
      "key": "text",
      "values": [
        "text"
      ]
    }
  ],
  "folderFilters": [
    {
      "operator": "is",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "searchText": "text",
  "sortBy": "text",
  "sortAsc": true
}

{
  "found": true,
  "page": 1,
  "rowIndex": 1,
  "reason": "text"
}

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

integer · int32Optional

401

Unauthorized

403

Forbidden

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

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/count HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

objectIdentifierstring · uuidOptional

flowDocumentCollectionObjectIdentifierstring · uuidOptional

documentsAssignedinteger · int32Optional

createdAtUtcstring · date-timeOptional

401

Unauthorized

403

Forbidden

409

Conflict

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

POST /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/assignments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowDocumentCollectionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentsAssigned": 1,
  "createdAtUtc": "2026-01-01T00:00:00.000Z"
}

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

objectIdentifierstring · uuidOptional

keystring · nullableOptional

valuestring · nullableOptional

401

Unauthorized

403

Forbidden

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

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/tags HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "key": "text",
    "value": "text"
  }
]

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

objectIdentifierstring · uuidOptional

keystring · nullableOptional

valuestring · nullableOptional

400

Bad Request

401

Unauthorized

403

Forbidden

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

PUT /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/tags HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "key": "text",
  "value": "text"
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "key": "text",
  "value": "text"
}

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

objectIdentifierstring · uuidOptional

keystring · nullableOptional

valuestring · nullableOptional

401

Unauthorized

403

Forbidden

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/tags

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/tags HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "key": "text",
    "value": "text"
  }
]

List the flow group's folder vocabulary.

get

Returns the distinct folders the group's documents sit in, plus "Home" when any are filed at the project root.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

string[]Optional

401

Unauthorized

403

Forbidden

get/projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/folders

GET /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/folders HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "text"
]

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

401

Unauthorized

403

Forbidden

404

Not Found

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

DELETE /projects/{projectIdentifier}/flow-groups/{flowGroupObjectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/tags/{tagObjectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousFlow Document Collection Assignments

NextFlow Documents

Last updated 25 days ago