Prompt Answers

Retrieves all prompt answers for a document in the specified flow.

get

Retrieves all prompt answers for a document in the specified flow.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

documentObjectIdentifierstring · uuidRequired

The unique identifier of the document.

projectIdentifierstringRequired
Query parameters
flattenbooleanOptional

Whether to flatten the prompt answer structure.

parentFilterObjectIdentifierstring · uuidOptional

Optional parent prompt object identifier.

Responses
chevron-right
200

OK

get
/projects/{projectIdentifier}/flows/{flowIdentifier}/document/{documentObjectIdentifier}/prompt-answers

Retrieves a prompt answer for a document and prompt in the specified flow.

get

Retrieves a prompt answer for a document and prompt in the specified flow.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired
Query parameters
filterObjectIdentifierstring · uuidOptional

The unique identifier of the prompt.

documentObjectIdentifierstring · uuidOptional

The unique identifier of the document.

Responses
chevron-right
200

OK

get
/projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/by-prompt-and-document

Retrieves a prompt answer by its object identifier.

get

Retrieves a prompt answer by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the prompt answer.

projectIdentifierstringRequired
flowIdentifierstringRequired
Responses
chevron-right
200

OK

get
/projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}

Updates a prompt answer by its object identifier.

put

Updates a prompt answer by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the prompt answer to update.

projectIdentifierstringRequired
flowIdentifierstringRequired
Body
failedToAnswerboolean · nullableOptional
contextLengthExceededboolean · nullableOptional
approvedboolean · nullableOptional
assignedTostring · nullableOptional
reviewedBystring · nullableOptional
decimalAnswernumber · double · nullableOptional
booleanAnswerboolean · nullableOptional
textAnswerstring · nullableOptional
quotestring · nullableOptional
reviewedDatestring · date-time · nullableOptional
Responses
chevron-right
200

OK

put
/projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}

Deletes a prompt answer by its object identifier.

delete

Deletes a prompt answer by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the prompt answer to delete.

projectIdentifierstringRequired
flowIdentifierstringRequired
Responses
delete
/projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}

No content

Updates the status of a prompt answer by its object identifier.

patch

Updates the status of a prompt answer by its object identifier.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired

The unique identifier of the prompt answer.

projectIdentifierstringRequired
flowIdentifierstringRequired
Body
booleanOptional
Responses
chevron-right
200

OK

patch
/projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}/status

Assigns a prompt answer to a user.

post

Assigns a prompt answer to a user.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
flowIdentifierstring · uuidRequired

The unique identifier of the flow.

objectIdentifierstring · uuidRequired

The unique identifier of the prompt answer.

projectIdentifierstringRequired
Body
stringOptional
Responses
post
/projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{objectIdentifier}/assign-to-user

No content

Adds categories to a prompt answer.

post

Adds categories to a prompt answer.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
promptAnswerObjectIdentifierstring · uuidRequired

The unique identifier of the prompt answer.

projectIdentifierstringRequired
flowIdentifierstringRequired
Bodystring · uuid[]
string · uuid[]Optional
Responses
post
/projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/categories

No content

Removes a category from a prompt answer.

delete

Removes a category from a prompt answer.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
promptAnswerObjectIdentifierstring · uuidRequired

The unique identifier of the prompt answer.

categoryObjectIdentifierstring · uuidRequired

The unique identifier of the category to remove.

projectIdentifierstringRequired
flowIdentifierstringRequired
Responses
delete
/projects/{projectIdentifier}/flows/{flowIdentifier}/prompt-answer/{promptAnswerObjectIdentifier}/categories/{categoryObjectIdentifier}

No content

Last updated