Flow Source Document

Retrieves a paginated list of source documents for the specified flow.

get

Retrieves a paginated list of source documents for the specified flow, optionally filtered and sorted.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

parentObjectIdentifierstring · uuidOptional

The parent folder's object identifier (optional).

flattenListbooleanOptional

Whether to flatten the folder structure.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter source documents.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

403

Forbidden

get

/projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents

GET /projects/{projectIdentifier}/flows/{flowIdentifier}/source-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-06T03:54:32.108Z",
    "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"
    }
  }
]

Uploads a new source document to the specified flow.

post

Uploads a new source document to the specified flow.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

flowIdentifierstringRequired

Query parameters

parentObjectIdentifierstring · uuidOptional

The parent folder's object identifier (optional).

Body

filestring · binaryOptional

The file to upload.

Responses

200

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents

POST /projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "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-06T03:54:32.108Z",
  "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"
  }
}

Retrieves a source document by its object identifier.

get

Retrieves a source document by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the source document.

projectIdentifierstringRequired

flowIdentifierstringRequired

Responses

200

403

Forbidden

404

Not Found

get

/projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents/{objectIdentifier}

GET /projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents/{objectIdentifier} 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-06T03:54:32.108Z",
  "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"
  }
}

Updates a source document by its object identifier.

put

Updates a source document by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the source document to update.

projectIdentifierstringRequired

flowIdentifierstringRequired

Body

namestring | nullableRequired

parentObjectIdentifierstring · uuid | nullableOptional

isDirectorybooleanOptional

documentUploadObjectIdentifierstring · uuidRequired

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

put

/projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents/{objectIdentifier}

PUT /projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents/{objectIdentifier} 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"
}

{
  "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-06T03:54:32.108Z",
  "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"
  }
}

Updates a folder by its object identifier.

put

Updates a folder by its object identifier.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the folder to update.

projectIdentifierstringRequired

flowIdentifierstringRequired

Body

namestring | nullableRequired

parentObjectIdentifierstring · uuid | nullableOptional

Responses

200

400

Bad Request

403

Forbidden

404

Not Found

put

/projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents/folder/{objectIdentifier}

PUT /projects/{projectIdentifier}/flows/{flowIdentifier}/source-documents/folder/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

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

{
  "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-06T03:54:32.108Z",
  "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"
  }
}

PreviousFlow Prompts NextFlows

Last updated 4 months ago