Skip to content

Read a set-up with its diagnosis and verified outcome

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/setup/runs/{id}
curl --request GET \  --url https://api.xovris.ai/v1/setup/runs/example \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
provider
required
One of:
string
steps
required
Array<object>
object
id
required
string
title
required
string
class
required
string
state
required
string
before
required
decisionId
required
One of:
string
attempts
required
number
at
required
One of:
string
adoptedFrom
required
One of:
string
foundInPlace
required
boolean
state
required
string
runId
required
string
startedAt
required
One of:
string
next
required
string
title
required
One of:
string
awaiting
required
One of:
object
kind
required
string
Allowed values: approve consent budget callback
stepId
required
One of:
string
outcome
required
One of:
object
title
required
string
verdict
required
string
Allowed values: not_checked passed pending not_observed
signal
required
One of:
string
evidence
required
at
required
One of:
string
recipe
required
string
note
required
One of:
string
finishedAt
required
One of:
string
signIn
required
One of:
object
stepId
required
One of:
string
domain
required
One of:
string
url
One of:
string
continues
required
One of:
string
diagnosis
required
One of:
object
class
required
string
Allowed values: paused no_consent budget cancelled expired_connection permission_denied mfa_required unsupported_environment physical_action provider_outage unexpected_answer dependency_conflict policy_refused egress_refused missing_capability not_approved consent_needed approval_needed callback_needed outcome_not_observed
stepId
required
One of:
string
words
required
string
xovrisNext
required
string
personNext
required
One of:
string
recovering
required
boolean
answer
string
personClears
boolean
methodFailed
boolean
budgetMicroUsd
required
number
inPlace
required
Array<string>
continuedBy
required
One of:
string
drawnMicroUsd
required
number

Example

{  "provider": "string",  "steps": [    {      "id": "string",      "title": "string",      "class": "string",      "state": "string",      "before": null,      "decisionId": "string",      "attempts": 1,      "at": "string",      "adoptedFrom": "string",      "foundInPlace": true    }  ],  "state": "string",  "runId": "string",  "startedAt": "string",  "next": "string",  "title": "string",  "awaiting": {    "kind": "approve",    "stepId": "string"  },  "outcome": {    "title": "string",    "verdict": "not_checked",    "signal": "string",    "evidence": null,    "at": "string"  },  "recipe": "string",  "note": "string",  "finishedAt": "string",  "signIn": {    "stepId": "string",    "domain": "string",    "url": "string"  },  "continues": "string",  "diagnosis": {    "class": "paused",    "stepId": "string",    "words": "string",    "xovrisNext": "string",    "personNext": "string",    "recovering": true,    "answer": "string",    "personClears": true,    "methodFailed": true  },  "budgetMicroUsd": 1,  "inPlace": [    "string"  ],  "continuedBy": "string",  "drawnMicroUsd": 1}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.