Submit assessment
Submit an asynchronous assessment request with documents, URLs, and assessment configuration. Returns an assessment process ID for polling.
Headers
KEYCLOAK_SUBJECTUUID of the authenticated partner (set by the API gateway from the Keycloak access token)
Submit assessment › Request Body
Configuration for an assessment request
documentsDocuments to be assessed (PDF, DOCX)
urlsURLs to be assessed
Submit assessment › Responses
Accepted — assessment process created. Use the Location header to poll for status.
assessmentProcessIdUnique identifier of the assessment process
statusCurrent status of the assessment process
completionCompletion percentage of the assessment process (0.0 to 1.0)
List of assessment responses (populated when status is COMPLETED)
Poll assessment status
Poll the current status and completion percentage of an assessment process. Returns 303 See Other with a Location header pointing to the results endpoint when the process is completed.
path Parameters
assessmentProcessIdUnique identifier of the assessment process
Headers
KEYCLOAK_SUBJECTUUID of the authenticated partner (set by the API gateway from the Keycloak access token)
Poll assessment status › Responses
OK — assessment is still in progress
assessmentProcessIdUnique identifier of the assessment process
statusCurrent status of the assessment process
completionCompletion percentage of the assessment process (0.0 to 1.0)
List of assessment responses (populated when status is COMPLETED)
Get assessment results
Retrieve the results of a completed assessment process, including category, rationale, and citations for each criterion assessed.
path Parameters
assessmentProcessIdUnique identifier of the assessment process
Headers
KEYCLOAK_SUBJECTUUID of the authenticated partner (set by the API gateway from the Keycloak access token)
Get assessment results › Responses
OK
idUnique identifier of the assessment result
assessmentProcessIdUnique identifier of the assessment process
inputTokensInput tokens used in the assessment
outputTokensOutput tokens generated by the assessment
processingTimeMsProcessing time in milliseconds
expertIdIdentifier of the expert who performed the assessment
fileNamesList of file names associated with the assessment
urlsList of URLs associated with the assessment
frameworkCodeNameCode name of the framework used in the assessment
criterionCodeNameCode name of the criterion used in the assessment
categoryCategory of the assessment result (e.g. SUFFICIENTLY REGULATED, NOT SUFFICIENTLY REGULATED, MISSING)
rationaleRationale behind the assessment result (markdown formatted)
List of citations supporting the assessment result
Cancel assessment
Cancel an ongoing assessment process. Only processes in PENDING or RUNNING status can be cancelled.
path Parameters
assessmentProcessIdUnique identifier of the assessment process
Headers
KEYCLOAK_SUBJECTUUID of the authenticated partner (set by the API gateway from the Keycloak access token)
Cancel assessment › Responses
OK — assessment cancelled
assessmentProcessIdUnique identifier of the assessment process
statusCurrent status of the assessment process
completionCompletion percentage of the assessment process (0.0 to 1.0)
List of assessment responses (populated when status is COMPLETED)