Skip to Content
veriom

Request workspace context inference

Have a model read the connected sources and suggest the architecture context. It runs in the background and is cheap to ask for again: a pass under way, or one that already read the same sources, is returned instead of a new one. Suggestions wait for a person to confirm or edit them and never replace an answer someone gave. Answering discovery questions takes an Analyst, so asking does too. 409 while nothing is connected.

POST
/v1/workspaces/{workspace_id}/setup/context-inference

Have a model read the connected sources and suggest the architecture context.

It runs in the background and is cheap to ask for again: a pass under way, or one that already read the same sources, is returned instead of a new one. Suggestions wait for a person to confirm or edit them and never replace an answer someone gave. Answering discovery questions takes an Analyst, so asking does too. 409 while nothing is connected.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json
  1. body
trigger?Trigger

setup: reuse a finished pass while the sources are unchanged. manual: a person asked again; still reused within ten minutes of the last pass.

Default"setup"
Value in"setup""manual"

Response Body

Successful Response

application/json
  1. response

The model pass that suggests architecture context from the connected sources.

completed_at?|null
error?|

Why a pass failed: the plan's processing allowance is used up, or the pass could not finish. Answer the questions by hand meanwhile.

id*Id
Formatuuid
requested_at*Requested At
Formatdate-time
stage*Stage

queued, reading, inferring, saving, done or failed.

stale*Stale

Something was connected or changed since this pass was asked for.

status*Status
Value in"queued""running""succeeded""failed"
suggestion_count*Suggestion Count
Range0 <= value
trigger*Trigger
Value in"setup""manual"
Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/setup/context-inference' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "completed_at": "2019-08-24T14:15:22Z",  "error": "allowance_exhausted",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "requested_at": "2019-08-24T14:15:22Z",  "stage": "string",  "stale": true,  "status": "queued",  "suggestion_count": 0,  "trigger": "setup"}