Skip to content

Connect an AI tool server by its address

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/tool-servers
curl --request POST \  --url https://api.xovris.ai/v1/tool-servers \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "serverUrl": null, "service": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
serverUrl
service

Example

{  "serverUrl": null,  "service": null}

Done.

Media typeapplication/json
object
status
required
string
service
required
string
servers
required
Array<object>
object
name
required
string
title
required
One of:
string
description
required
string
serverUrl
required
string
keyNeeded
required
boolean
publishedBy
required
One of:
string
updatedAt
required
One of:
string
next
required
string

Example

{  "status": "string",  "service": "string",  "servers": [    {      "name": "string",      "title": "string",      "description": "string",      "serverUrl": "string",      "keyNeeded": true,      "publishedBy": "string",      "updatedAt": "string"    }  ],  "next": "string"}

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

Media typeapplication/json
object
next
required
string
id
required
string
status
required
string
serverUrl
required
string
name
required
One of:
string
signInRequired
required
boolean
scopes
required
Array<string>
tools
required
Array<object>
object
name
required
string
class
required
string
Allowed values: billing read write
enabled
required
boolean
approved
required
boolean
disabledReason
required
One of:
string

Example

{  "next": "string",  "id": "string",  "status": "string",  "serverUrl": "string",  "name": "string",  "signInRequired": true,  "scopes": [    "string"  ],  "tools": [    {      "name": "string",      "class": "billing",      "enabled": true,      "approved": true,      "disabledReason": "string"    }  ]}

Started: the answer says where to follow it.

Media typeapplication/json
object
id
required
string
status
required
string
approveAt
required
string
host
required
string
scopes
required
Array<string>
next
required
string

Example

{  "id": "string",  "status": "string",  "approveAt": "string",  "host": "string",  "scopes": [    "string"  ],  "next": "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.