Skip to Content
veriom

Get architecture explanation

The newest version (whatever its state), or a specific one with ``version``.

GET
/v1/workspaces/{workspace_id}/audits/{audit_id}/architecture/explanation

The newest version (whatever its state), or a specific one with version.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid
audit_id*Audit Id
Formatuuid

Query Parameters

version?|null

Response Body

Successful Response

application/json
  1. response

One version of an audit's architecture explanation, in whatever state it is in.

audit_id*Audit Id
Formatuuid
completed_at*|null
created_at*Created At
Formatdate-time
elements*array<>
error_code*string|null
error_message*string|null
graph_fingerprint*string|null
grounding*
id*Id
Formatuuid
model_id*string|null
progress*
prompt_version*Prompt Version
requested_by*|null
reused_from_version?integer|null
sections*array<>
started_at*|null
status*Status
Value in"queued""dispatched""running""succeeded""failed"
summary*string|null
trigger*Trigger
Value in"audit_completed""manual"
uncertainty_notes*array<string>
version*Version
Example Request
curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/audits/497f6eca-6276-4993-bfeb-53cbbbba6f08/architecture/explanation'
Example Response
{  "audit_id": "78c04fa6-cfb4-46a0-9aa5-3681ba4f3897",  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "elements": [    {      "confidence": 0,      "decision_ids": [        "string"      ],      "evidence_ids": [        "string"      ],      "finding_ids": [        "string"      ],      "key": "string",      "name": "string",      "risks": [        {          "evidence_ids": [            "string"          ],          "finding_ids": [            "string"          ],          "text": "string"        }      ],      "subject": "entity",      "uncertainty": "string",      "what": "string",      "why_it_matters": "string"    }  ],  "error_code": "string",  "error_message": "string",  "graph_fingerprint": "string",  "grounding": {    "property1": 0,    "property2": 0  },  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "model_id": "string",  "progress": {    "completed": 0,    "stage": "queued",    "total": 4  },  "prompt_version": "string",  "requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",  "reused_from_version": 0,  "sections": [    {      "body": "string",      "element_keys": [        "string"      ],      "evidence_ids": [        "string"      ],      "title": "string"    }  ],  "started_at": "2019-08-24T14:15:22Z",  "status": "queued",  "summary": "string",  "trigger": "audit_completed",  "uncertainty_notes": [    "string"  ],  "version": 0}