Skip to content

Register an app or an AI client that signs in with Xovris

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.

POST
/v1/oauth/register
curl --request POST \  --url https://api.xovris.ai/v1/oauth/register \  --header 'Content-Type: application/json' \  --data '{}'

Open to anyone, so no Idempotency-Key is kept: nobody is signed in to keep it for, and replaying one caller’s answer to another would hand it over.

No token needed: anyone may call this.

Media typeapplication/json
object

Example generated

{}

Done.

Media typeapplication/json
One of:
object
key
additional properties

Example

{}

Done: something new was made, and the answer is it.

Media typeapplication/json
object

Example generated

{}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

Refused, as OAuth 2.0 says (RFC 6749, RFC 7591, RFC 8628).

Media typeapplication/json

An OAuth 2.0 error (RFC 6749 section 5.2; RFC 8628 section 3.5 for the device grant).

object
error
required

The standard’s code, such as invalid_request, invalid_grant, authorization_pending or slow_down.

string
error_description

What happened and what to do next, in plain words.

string
error_uri
string

Example generated

{  "error": "example",  "error_description": "example",  "error_uri": "example"}

Refused, as OAuth 2.0 says (RFC 6749, RFC 7591, RFC 8628).

Media typeapplication/json

An OAuth 2.0 error (RFC 6749 section 5.2; RFC 8628 section 3.5 for the device grant).

object
error
required

The standard’s code, such as invalid_request, invalid_grant, authorization_pending or slow_down.

string
error_description

What happened and what to do next, in plain words.

string
error_uri
string

Example generated

{  "error": "example",  "error_description": "example",  "error_uri": "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"  }}

Refused or failed: an OAuth 2.0 error from the standard’s own checks, otherwise the Problem with what to do next.

One of:
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.