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

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Query parameters

skipinteger · int32OptionalDefault: 0

takeinteger · int32OptionalDefault: 50

Responses

200

OK

text/plainapplication/jsontext/json

totalCountinteger · int32Optional

skipinteger · int32Optional

takeinteger · int32Optional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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-07-11T02:17:28.920Z",
      "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

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring · nullableRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

namestring · nullableOptional

dateAddedstring · date-timeOptional

hasActiveAssignmentbooleanOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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"
      ]
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "dateAdded": "2026-07-11T02:17:28.920Z",
  "hasActiveAssignment": true
}

Bulk-create flow document collections.

post

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

documentObjectIdentifiersstring · uuid[] · nullableOptional

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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"
  ]
}

application/jsontext/jsonapplication/*+json

No content

Get a flow document collection.

get

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

namestring · nullableOptional

dateAddedstring · date-timeOptional

hasActiveAssignmentbooleanOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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-07-11T02:17:28.920Z",
  "hasActiveAssignment": true
}

Delete a flow document collection.

delete

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

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

text/plainapplication/jsontext/json

totalCountinteger · int32Optional

pageinteger · int32Optional

pageSizeinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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: 553

{
  "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"
      ]
    }
  ],
  "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"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "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-07-11T02:17:28.920Z",
          "fileType": "unknown",
          "tokenCount": 1,
          "pageCount": 1,
          "convertedToPdf": true,
          "flowDocumentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "promptAnswers": {
        "ANY_ADDITIONAL_PROPERTY": {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "booleanAnswer": true,
          "textAnswer": "text",
          "decimalAnswer": 1,
          "dateAnswer": "2026-07-11T02:17:28.920Z",
          "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"
        }
      ]
    }
  ]
}

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

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

promptAnswerObjectIdentifierstring · uuidOptional

pageSizeinteger · int32Optional

logicOperatorstring · enumOptionalPossible values:

searchTextstring · nullableOptional

sortBystring · nullableOptional

sortAscboolean · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

foundbooleanOptional

pageinteger · int32 · nullableOptional

rowIndexinteger · int32 · nullableOptional

reasonstring · nullableOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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: 385

{
  "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"
      ]
    }
  ],
  "searchText": "text",
  "sortBy": "text",
  "sortAsc": true
}

application/jsontext/jsonapplication/*+json

{
  "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

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

integer · int32Optional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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: */*

1

Add documents to a collection.

post

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

collectionObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

documentObjectIdentifiersstring · uuid[] · nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

flowDocumentCollectionObjectIdentifierstring · uuidOptional

documentsAssignedinteger · int32Optional

createdAtUtcstring · date-timeOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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"
  ]
}

application/jsontext/jsonapplication/*+json

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowDocumentCollectionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentsAssigned": 1,
  "createdAtUtc": "2026-07-11T02:17:28.920Z"
}

List a collection's tags.

get

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

collectionObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

keystring · nullableOptional

valuestring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

collectionObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

keystring · nullableRequired

valuestring · nullableRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

keystring · nullableOptional

valuestring · nullableOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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"
}

application/jsontext/jsonapplication/*+json

{
  "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

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowGroupObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

keystring · nullableOptional

valuestring · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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"
  }
]

Remove a collection tag.

delete

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

collectionObjectIdentifierstring · uuidRequired

tagObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowGroupObjectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

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

HTTPcURLJavaScriptPython

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