Skip to content

List every set-up Xovris can run, with what it changes, the keys it needs and the outcome it proves

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/recipes
curl --request GET \  --url https://api.xovris.ai/v1/setup/recipes \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
version
required
number
provider
required
string
title
required
string
means
required
One of:
string
Allowed values: api
status
required
string
Allowed values: confirmed candidate demoted
scopes
required
Array<string>
what
required
object
what
required
string
access
required
string
undo
required
string
steps
required
Array<object>
object
id
required
string
title
required
string
class
required
string
Allowed values: billing read secret write
kind
required
string
Allowed values: http browser person consent handler mcp callback readback invoke
input
required
Array<object>
object
name
required
string
label
required
string
required
required
boolean
needs
required
Array<object>
object
ref
required
string
label
required
string
kind
required
string
Allowed values: key oauth
where
string
outcome
required
One of:
object
title
required
string
withinSeconds
required
number
record
required
string
start
required
object
method
required
string
path
required
string
body
required
object
recipe
required
string
version
required
number
runner
required
string

Example

{  "items": [    {      "id": "string",      "version": 1,      "provider": "string",      "title": "string",      "means": "api",      "status": "confirmed",      "scopes": [        "string"      ],      "what": {        "what": "string",        "access": "string",        "undo": "string"      },      "steps": [        {          "id": "string",          "title": "string",          "class": "billing",          "kind": "http"        }      ],      "input": [        {          "name": "string",          "label": "string",          "required": true        }      ],      "needs": [        {          "ref": "string",          "label": "string",          "kind": "key",          "where": "string"        }      ],      "outcome": {        "title": "string",        "withinSeconds": 1      },      "record": "string",      "start": {        "method": "string",        "path": "string",        "body": {          "recipe": "string",          "version": 1        }      }    }  ],  "runner": "string"}

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.