For the complete documentation index, see llms.txt. This page is also available as Markdown.

Assemblies

List assemblies for a flow.

get

Returns a paginated list of the assemblies (document templates) configured against a flow.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Query parameters
pageinteger · int32OptionalDefault: 1
pageSizeinteger · int32OptionalDefault: 20
Responses
200

OK

totalCountinteger · int32Optional
get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies

Create an assembly.

post

Creates a new assembly (document template) within a flow from an uploaded file and metadata.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
NamestringRequired
DescriptionstringOptional
Typestring · enumRequiredPossible values:
FlowGroupIdstring · uuidOptional
Filestring · binaryOptional
Responses
200

OK

objectIdentifierstring · uuidOptional
namestring · nullableOptional
descriptionstring · nullableOptional
typestring · enumOptionalPossible values:
extensionstring · nullableOptional
sizeinteger · int64Optional
contentTypestring · nullableOptional
dateAddedstring · date-timeOptional
dateModifiedstring · date-timeOptional
flowGroupObjectIdentifierstring · uuid · nullableOptional
post/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies

Generate a document from an assembly.

post

Queues generation of a populated document from an assembly template and returns the identifier used to track and download the result.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowObjectIdentifierstring · uuidRequired
assemblyObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
flowDocumentCollectionObjectIdentifierstring · uuid · nullableOptional
Responses
200

OK

downloadObjectIdentifierstring · uuidOptional
post/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/generate

Get an assembly by identifier.

get

Returns the metadata of a single assembly (document template) by its identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
assemblyObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
namestring · nullableOptional
descriptionstring · nullableOptional
typestring · enumOptionalPossible values:
extensionstring · nullableOptional
sizeinteger · int64Optional
contentTypestring · nullableOptional
dateAddedstring · date-timeOptional
dateModifiedstring · date-timeOptional
flowGroupObjectIdentifierstring · uuid · nullableOptional
get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}

Delete an assembly.

delete

Permanently deletes an assembly and its backing document from a flow.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
assemblyObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
Responses
204

No Content

No content

delete/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}

No content

Download an assembly's document.

get

Returns the assembly's backing document as a file, optionally converted to PDF.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowObjectIdentifierstring · uuidRequired
assemblyObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Query parameters
usePdfbooleanOptionalDefault: false
Responses
200

OK

string · binaryOptional
get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/content

Replace an assembly's document.

put

Overwrites the assembly's backing document with the uploaded file.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowObjectIdentifierstring · uuidRequired
assemblyObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Body
filestring · binaryOptional
Responses
200

OK

No content

put/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/content

No content

Get a signed download URL.

get

Returns a short-lived, signed URL for opening or downloading the assembly's document directly.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowObjectIdentifierstring · uuidRequired
assemblyObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
Responses
200

OK

No content

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/download-url

No content

List references for an assembly.

get

Returns a paginated list of the references configured for a flow assembly.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
assemblyObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
Query parameters
pageinteger · int32OptionalDefault: 1
pageSizeinteger · int32OptionalDefault: 20
Responses
200

OK

totalCountinteger · int32Optional
get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references

Create an assembly reference.

post

Adds a new reference to a flow assembly, linking it to a source and defining how that source is formatted.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
assemblyObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
Body
flowPromptObjectIdentifierstring · uuidOptional
assemblyReferenceTypestring · enumOptionalPossible values:
multiDocumentListFormatstring · enumOptionalPossible values:
singleDocumentReferenceFormatstring · enumOptionalPossible values:
singleDocumentAnswerListFormatstring · enumOptionalPossible values:
playbookAssemblyReferenceIdentifierstring · uuidOptional
Responses
201

Created

objectIdentifierstring · uuidOptional
stableObjectIdentifierstring · uuidOptional
flowAssemblyObjectIdentifierstring · uuidOptional
flowPromptObjectIdentifierstring · uuidOptional
flowGroupObjectIdentifierstring · uuidOptional
promptDataTypestring · enumOptionalPossible values:
assemblyReferenceTypestring · enumOptionalPossible values:
multiDocumentListFormatstring · enumOptionalPossible values:
singleDocumentReferenceFormatstring · enumOptionalPossible values:
singleDocumentAnswerListFormatstring · enumOptionalPossible values:
playbookAssemblyReferenceIdentifierstring · uuidOptional
post/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references

Get an assembly reference.

get

Retrieves a single assembly reference by its identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
assemblyObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
stableObjectIdentifierstring · uuidOptional
flowAssemblyObjectIdentifierstring · uuidOptional
flowPromptObjectIdentifierstring · uuidOptional
flowGroupObjectIdentifierstring · uuidOptional
promptDataTypestring · enumOptionalPossible values:
assemblyReferenceTypestring · enumOptionalPossible values:
multiDocumentListFormatstring · enumOptionalPossible values:
singleDocumentReferenceFormatstring · enumOptionalPossible values:
singleDocumentAnswerListFormatstring · enumOptionalPossible values:
playbookAssemblyReferenceIdentifierstring · uuidOptional
get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{objectIdentifier}

Update an assembly reference.

put

Updates the configuration of an existing assembly reference and returns the updated record.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
assemblyObjectIdentifierstringRequired
Body
assemblyReferenceTypestring · enumOptionalPossible values:
multiDocumentListFormatstring · enumOptionalPossible values:
singleDocumentReferenceFormatstring · enumOptionalPossible values:
singleDocumentAnswerListFormatstring · enumOptionalPossible values:
playbookAssemblyReferenceIdentifierstring · uuidOptional
Responses
200

OK

objectIdentifierstring · uuidOptional
stableObjectIdentifierstring · uuidOptional
flowAssemblyObjectIdentifierstring · uuidOptional
flowPromptObjectIdentifierstring · uuidOptional
flowGroupObjectIdentifierstring · uuidOptional
promptDataTypestring · enumOptionalPossible values:
assemblyReferenceTypestring · enumOptionalPossible values:
multiDocumentListFormatstring · enumOptionalPossible values:
singleDocumentReferenceFormatstring · enumOptionalPossible values:
singleDocumentAnswerListFormatstring · enumOptionalPossible values:
playbookAssemblyReferenceIdentifierstring · uuidOptional
put/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{objectIdentifier}

Delete an assembly reference.

delete

Removes an assembly reference from a flow assembly.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
assemblyObjectIdentifierstringRequired
Responses
204

No Content

No content

delete/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{objectIdentifier}

No content

List template columns.

get

Returns a paginated list of the template columns configured for an assembly reference.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
assemblyObjectIdentifierstringRequired
Query parameters
pageinteger · int32OptionalDefault: 1
pageSizeinteger · int32OptionalDefault: 20
Responses
200

OK

totalCountinteger · int32Optional
get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/template-columns

Create a template column.

post

Creates a new template column for an assembly reference, defined by a name and a rich-text template.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceObjectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
assemblyObjectIdentifierstringRequired
Body
namestring · nullableRequired
Responses
201

Created

objectIdentifierstring · uuidOptional
assemblyReferenceObjectIdentifierstring · uuidOptional
namestring · nullableOptional
post/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/template-columns

Get a template column.

get

Returns the details of a single template column identified by its GUID.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
assemblyObjectIdentifierstringRequired
referenceObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
assemblyReferenceObjectIdentifierstring · uuidOptional
namestring · nullableOptional
get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/template-columns/{objectIdentifier}

Update a template column.

put

Updates the name and rich-text template of an existing template column.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
assemblyObjectIdentifierstringRequired
referenceObjectIdentifierstringRequired
Body
namestring · nullableRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
assemblyReferenceObjectIdentifierstring · uuidOptional
namestring · nullableOptional
put/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/template-columns/{objectIdentifier}

Delete a template column.

delete

Permanently deletes a template column from an assembly reference.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
projectIdentifierstringRequired
flowObjectIdentifierstringRequired
assemblyObjectIdentifierstringRequired
referenceObjectIdentifierstringRequired
Responses
204

No Content

No content

delete/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/template-columns/{objectIdentifier}

No content

Last updated