Flow Documents

Gets all flow documents for the specified flow.

get

Retrieves a paginated list of all flow documents for the specified flow, with optional search and sorting.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The object identifier of the flow.

playbookIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number for paginated results.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter results.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/flow-documents

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/flows/{flowIdentifier}/flow-documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "name": "text",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "isDirectory": true,
    "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "contentType": "text",
    "size": 1,
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2025-12-06T04:14:37.886Z",
    "uploadSuccessful": true,
    "tokenCount": 1,
    "metadataTokenCount": 1,
    "unsupportedFileType": true,
    "unPackingComplete": true,
    "unPackingFailed": true,
    "uploadInProgress": true,
    "url": "text",
    "hasChildren": true,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    },
    "flowSuccess": true,
    "flowIsCompleting": true,
    "totalPromptsCount": 1,
    "approvedCount": 1,
    "rejectedCount": 1,
    "reviewedByUsers": [
      {
        "email": "text",
        "name": "text",
        "resourceOwnerId": "text"
      }
    ],
    "assignedToUsers": [
      {
        "email": "text",
        "name": "text",
        "resourceOwnerId": "text"
      }
    ],
    "promptAnswers": [
      {
        "failedToAnswer": true,
        "contextLengthExceeded": true,
        "approved": true,
        "assignedTo": "text",
        "reviewedBy": "text",
        "decimalAnswer": 1,
        "booleanAnswer": true,
        "textAnswer": "text",
        "quote": "text",
        "reviewedDate": "2025-12-06T04:14:37.886Z",
        "dateAdded": "2025-12-06T04:14:37.886Z",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "prompt": {
          "label": "text",
          "description": "text",
          "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "question": "text",
          "questionJson": {
            "type": "text",
            "content": "[Circular Reference]"
          },
          "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "conditions": [
            "[Circular Reference]"
          ],
          "promptDataTypeId": 1,
          "dateAdded": "2025-12-06T04:14:37.886Z",
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "categories": [
            {
              "name": "text",
              "colour": 0,
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "colourHex": "text"
            }
          ],
          "minimumValue": 1,
          "maximumValue": 1,
          "found": true,
          "hasChildren": true
        },
        "document": {
          "name": "text",
          "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "isDirectory": true,
          "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "contentType": "text",
          "size": 1,
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "dateAdded": "2025-12-06T04:14:37.886Z",
          "uploadSuccessful": true,
          "tokenCount": 1,
          "metadataTokenCount": 1,
          "unsupportedFileType": true,
          "unPackingComplete": true,
          "unPackingFailed": true,
          "uploadInProgress": true,
          "url": "text",
          "hasChildren": true,
          "resourceOwner": {
            "email": "text",
            "name": "text",
            "id": "text"
          }
        },
        "reviewedByMember": {
          "email": "text",
          "name": "text",
          "resourceOwnerId": "text"
        },
        "assignedToMember": {
          "email": "text",
          "name": "text",
          "resourceOwnerId": "text"
        },
        "hasChildren": true,
        "checkIsFlowWideAssemblyAnswer": true,
        "categories": [
          {
            "name": "text",
            "colour": 0,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "colourHex": "text"
          }
        ],
        "promptAnswerCategories": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "category": {
              "name": "text",
              "colour": 0,
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "colourHex": "text"
            },
            "evidence": [
              {
                "quoteOnly": true,
                "text": "text",
                "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
                "polygonPoints": [
                  1
                ],
                "pageNumber": 1,
                "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
                "dateAdded": "2025-12-06T04:14:37.886Z"
              }
            ]
          }
        ],
        "flowWideAssemblyAnswer": true,
        "evidence": [
          {
            "quoteOnly": true,
            "text": "text",
            "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "polygonPoints": [
              1
            ],
            "pageNumber": 1,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "dateAdded": "2025-12-06T04:14:37.886Z"
          }
        ]
      }
    ]
  }
]

Adds a range of documents to the specified flow.

post

Adds a range of documents to the specified flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The object identifier of the flow.

playbookIdentifierstringRequired

Bodystring · uuid[]

application/jsontext/jsonapplication/*+json

string · uuid[]Optional

Responses

200

OK

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/flow-documents

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/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"
]

application/jsontext/jsonapplication/*+json

No content

Removes a range of documents from the specified flow.

delete

Removes a range of documents from the specified flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The object identifier of the flow.

playbookIdentifierstringRequired

Query parameters

objectIdentifiersstring · uuid[]Optional

The collection of document object identifiers to remove.

Responses

200

OK

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

delete

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/flow-documents

HTTPcURLJavaScriptPython

DELETE /playbooks/{playbookIdentifier}/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.

post

Searches for flow documents in the specified flow using the provided search model.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The object identifier of the flow.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

searchTextstring | nullableOptional

pageNumberinteger · int32 | nullableOptional

pageSizeinteger · int32 | nullableOptional

sortBystring | nullableOptional

sortAscboolean | nullableOptional

documentsToSearchstring · uuid[] | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/flow-documents/search

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/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"
  ]
}

application/jsontext/jsonapplication/*+json

[
  {
    "name": "text",
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "isDirectory": true,
    "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "contentType": "text",
    "size": 1,
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2025-12-06T04:14:37.886Z",
    "uploadSuccessful": true,
    "tokenCount": 1,
    "metadataTokenCount": 1,
    "unsupportedFileType": true,
    "unPackingComplete": true,
    "unPackingFailed": true,
    "uploadInProgress": true,
    "url": "text",
    "hasChildren": true,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    },
    "flowSuccess": true,
    "flowIsCompleting": true,
    "totalPromptsCount": 1,
    "approvedCount": 1,
    "rejectedCount": 1,
    "reviewedByUsers": [
      {
        "email": "text",
        "name": "text",
        "resourceOwnerId": "text"
      }
    ],
    "assignedToUsers": [
      {
        "email": "text",
        "name": "text",
        "resourceOwnerId": "text"
      }
    ],
    "promptAnswers": [
      {
        "failedToAnswer": true,
        "contextLengthExceeded": true,
        "approved": true,
        "assignedTo": "text",
        "reviewedBy": "text",
        "decimalAnswer": 1,
        "booleanAnswer": true,
        "textAnswer": "text",
        "quote": "text",
        "reviewedDate": "2025-12-06T04:14:37.886Z",
        "dateAdded": "2025-12-06T04:14:37.886Z",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "prompt": {
          "label": "text",
          "description": "text",
          "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "question": "text",
          "questionJson": {
            "type": "text",
            "content": "[Circular Reference]"
          },
          "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "conditions": [
            "[Circular Reference]"
          ],
          "promptDataTypeId": 1,
          "dateAdded": "2025-12-06T04:14:37.886Z",
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "categories": [
            {
              "name": "text",
              "colour": 0,
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "colourHex": "text"
            }
          ],
          "minimumValue": 1,
          "maximumValue": 1,
          "found": true,
          "hasChildren": true
        },
        "document": {
          "name": "text",
          "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "isDirectory": true,
          "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "contentType": "text",
          "size": 1,
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "dateAdded": "2025-12-06T04:14:37.886Z",
          "uploadSuccessful": true,
          "tokenCount": 1,
          "metadataTokenCount": 1,
          "unsupportedFileType": true,
          "unPackingComplete": true,
          "unPackingFailed": true,
          "uploadInProgress": true,
          "url": "text",
          "hasChildren": true,
          "resourceOwner": {
            "email": "text",
            "name": "text",
            "id": "text"
          }
        },
        "reviewedByMember": {
          "email": "text",
          "name": "text",
          "resourceOwnerId": "text"
        },
        "assignedToMember": {
          "email": "text",
          "name": "text",
          "resourceOwnerId": "text"
        },
        "hasChildren": true,
        "checkIsFlowWideAssemblyAnswer": true,
        "categories": [
          {
            "name": "text",
            "colour": 0,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "colourHex": "text"
          }
        ],
        "promptAnswerCategories": [
          {
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "category": {
              "name": "text",
              "colour": 0,
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "colourHex": "text"
            },
            "evidence": [
              {
                "quoteOnly": true,
                "text": "text",
                "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
                "polygonPoints": [
                  1
                ],
                "pageNumber": 1,
                "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
                "dateAdded": "2025-12-06T04:14:37.886Z"
              }
            ]
          }
        ],
        "flowWideAssemblyAnswer": true,
        "evidence": [
          {
            "quoteOnly": true,
            "text": "text",
            "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "polygonPoints": [
              1
            ],
            "pageNumber": 1,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "dateAdded": "2025-12-06T04:14:37.886Z"
          }
        ]
      }
    ]
  }
]

Gets the details of a specific flow document by its document identifier.

get

Retrieves the details of a flow document using its document identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The object identifier of the flow.

documentIdentifierstring · uuidRequired

The object identifier of the document.

playbookIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/flow-documents/{documentIdentifier}

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/flows/{flowIdentifier}/flow-documents/{documentIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "contentType": "text",
  "size": 1,
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:14:37.886Z",
  "uploadSuccessful": true,
  "tokenCount": 1,
  "metadataTokenCount": 1,
  "unsupportedFileType": true,
  "unPackingComplete": true,
  "unPackingFailed": true,
  "uploadInProgress": true,
  "url": "text",
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "flowSuccess": true,
  "flowIsCompleting": true,
  "totalPromptsCount": 1,
  "approvedCount": 1,
  "rejectedCount": 1,
  "reviewedByUsers": [
    {
      "email": "text",
      "name": "text",
      "resourceOwnerId": "text"
    }
  ],
  "assignedToUsers": [
    {
      "email": "text",
      "name": "text",
      "resourceOwnerId": "text"
    }
  ],
  "promptAnswers": [
    {
      "failedToAnswer": true,
      "contextLengthExceeded": true,
      "approved": true,
      "assignedTo": "text",
      "reviewedBy": "text",
      "decimalAnswer": 1,
      "booleanAnswer": true,
      "textAnswer": "text",
      "quote": "text",
      "reviewedDate": "2025-12-06T04:14:37.886Z",
      "dateAdded": "2025-12-06T04:14:37.886Z",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "prompt": {
        "label": "text",
        "description": "text",
        "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "question": "text",
        "questionJson": {
          "type": "text",
          "content": [
            "[Circular Reference]"
          ]
        },
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "conditions": [
          {
            "fuzzyMatch": true,
            "isYes": true,
            "minimumDecimalAnswer": 1,
            "maximumDecimalAnswer": 1,
            "decimalOperator": "Equal",
            "decimalAnswer": 1,
            "textAnswer": "text",
            "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "categories": [
              {
                "fuzzyMatch": true,
                "text": "text"
              }
            ],
            "allCategoriesMatch": true,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "promptPredicate": "[Circular Reference]"
          }
        ],
        "promptDataTypeId": 1,
        "dateAdded": "2025-12-06T04:14:37.886Z",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "categories": [
          {
            "name": "text",
            "colour": 0,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "colourHex": "text"
          }
        ],
        "minimumValue": 1,
        "maximumValue": 1,
        "found": true,
        "hasChildren": true
      },
      "document": {
        "name": "text",
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "isDirectory": true,
        "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "contentType": "text",
        "size": 1,
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "dateAdded": "2025-12-06T04:14:37.886Z",
        "uploadSuccessful": true,
        "tokenCount": 1,
        "metadataTokenCount": 1,
        "unsupportedFileType": true,
        "unPackingComplete": true,
        "unPackingFailed": true,
        "uploadInProgress": true,
        "url": "text",
        "hasChildren": true,
        "resourceOwner": {
          "email": "text",
          "name": "text",
          "id": "text"
        }
      },
      "reviewedByMember": {
        "email": "text",
        "name": "text",
        "resourceOwnerId": "text"
      },
      "assignedToMember": {
        "email": "text",
        "name": "text",
        "resourceOwnerId": "text"
      },
      "hasChildren": true,
      "checkIsFlowWideAssemblyAnswer": true,
      "categories": [
        {
          "name": "text",
          "colour": 0,
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "colourHex": "text"
        }
      ],
      "promptAnswerCategories": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "category": {
            "name": "text",
            "colour": 0,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "colourHex": "text"
          },
          "evidence": [
            {
              "quoteOnly": true,
              "text": "text",
              "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "polygonPoints": [
                1
              ],
              "pageNumber": 1,
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "dateAdded": "2025-12-06T04:14:37.886Z"
            }
          ]
        }
      ],
      "flowWideAssemblyAnswer": true,
      "evidence": [
        {
          "quoteOnly": true,
          "text": "text",
          "paragraphObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "polygonPoints": [
            1
          ],
          "pageNumber": 1,
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "dateAdded": "2025-12-06T04:14:37.886Z"
        }
      ]
    }
  ]
}

Moves documents to a specified folder.

post

Moves documents to a specified folder using the provided move documents model.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The object identifier of the flow.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

folderIdentifierstring · uuidOptional

Responses

200

OK

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/flow-documents/move-documents

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/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"
      ]
    }
  }
}

application/jsontext/jsonapplication/*+json

No content