Flow Documents

List documents in a flow collection.

get

Returns a paginated list of documents in the specified flow document collection, including the total count for pagination.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

collectionObjectIdentifierstring · 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-document-collections/{collectionObjectIdentifier}/documents

GET /projects/{projectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/documents 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",
      "flowDocumentCollectionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "document": {
        "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,
        "folder": "text",
        "filePath": "text"
      }
    }
  ]
}

Add a document to a flow collection.

post

Links an existing document into a flow document collection so it can be used by flows in the project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

collectionObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Body

documentObjectIdentifierstring · uuidRequired

Responses

200

objectIdentifierstring · uuidOptional

namestring · nullableOptional

flowDocumentCollectionObjectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

401

Unauthorized

403

Forbidden

409

Conflict

post/projects/{projectIdentifier}/flow-document-collections/{collectionObjectIdentifier}/documents

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

{
  "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "flowDocumentCollectionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "document": {
    "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,
    "folder": "text",
    "filePath": "text"
  }
}

Remove a document from a flow collection.

delete

Unlinks a document from its flow document collection. The original document is not deleted, only its association with the collection. All prompt answers for that collection are deleted because they are no longer valid once the collection's documents change.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

delete/projects/{projectIdentifier}/flow-documents/{objectIdentifier}

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

No content

List flow reference material documents.

get

Returns a paginated list of the documents and folders directly inside a flow reference material's folder, or at its top level when no parent is given.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

referenceMaterialObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Query parameters

pageNumberinteger · int32OptionalDefault: 1

pageSizeinteger · int32OptionalDefault: 20

parentObjectIdentifierstring · uuidOptional

Responses

200

totalCountinteger · int32Optional

400

Bad Request

401

Unauthorized

403

Forbidden

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "isDirectory": true,
      "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "extension": "text",
      "resourceOwnerId": "text",
      "resourceOwner": {
        "name": "text",
        "id": "text",
        "email": "text",
        "picture": "text",
        "roles": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      }
    }
  ],
  "totalCount": 1
}

Create a flow document or folder.

post

Creates a new document or folder within a flow reference material's file tree, optionally nested under a parent folder.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

referenceMaterialObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Body

namestring · nullableRequired

parentObjectIdentifierstring · uuid · nullableOptional

isDirectorybooleanOptional

documentUploadObjectIdentifierstring · uuid · nullableOptional

Responses

201

Created

objectIdentifierstring · uuidOptional

namestring · nullableOptional

isDirectorybooleanOptional

parentObjectIdentifierstring · uuid · nullableOptional

documentUploadObjectIdentifierstring · uuid · nullableOptional

flowReferenceMaterialObjectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

extensionstring · nullableOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

403

Forbidden

post/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents

POST /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDirectory": true,
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "extension": "text",
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Get a flow document by id.

get

Returns the details of a single document or folder within a flow reference material.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

referenceMaterialObjectIdentifierstringRequired

Responses

200

objectIdentifierstring · uuidOptional

namestring · nullableOptional

isDirectorybooleanOptional

parentObjectIdentifierstring · uuid · nullableOptional

documentUploadObjectIdentifierstring · uuid · nullableOptional

flowReferenceMaterialObjectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

extensionstring · nullableOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

403

Forbidden

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDirectory": true,
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "extension": "text",
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Update a flow document.

put

Updates a flow document or folder, for example to move it to a different parent folder.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

referenceMaterialObjectIdentifierstringRequired

Body

parentObjectIdentifierstring · uuid · nullableOptional

Responses

200

objectIdentifierstring · uuidOptional

namestring · nullableOptional

isDirectorybooleanOptional

parentObjectIdentifierstring · uuid · nullableOptional

documentUploadObjectIdentifierstring · uuid · nullableOptional

flowReferenceMaterialObjectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

extensionstring · nullableOptional

resourceOwnerIdstring · nullableOptional

401

Unauthorized

403

Forbidden

put/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}

PUT /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "isDirectory": true,
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowReferenceMaterialObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "extension": "text",
  "resourceOwnerId": "text",
  "resourceOwner": {
    "name": "text",
    "id": "text",
    "email": "text",
    "picture": "text",
    "roles": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Delete a flow document or folder.

delete

Permanently deletes a document or folder from a flow reference material.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

referenceMaterialObjectIdentifierstringRequired

Responses

204

No Content

No content

401

Unauthorized

403

Forbidden

delete/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}

DELETE /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Download a flow document file.

get

Streams the file content of a flow document, optionally as a PDF rendition.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

referenceMaterialObjectIdentifierstringRequired

Query parameters

usePdfbooleanOptionalDefault: false

Responses

200

string · binaryOptional

401

Unauthorized

403

Forbidden

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}/download

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/reference-materials/{referenceMaterialObjectIdentifier}/documents/{objectIdentifier}/download HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

PreviousFlow Document Collections

NextFlow Group Assignment Entries

Last updated 25 days ago