Skip to content

Connect a tool

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-connections
curl --request POST \  --url https://api.xovris.ai/v1/tool-connections \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "tool": null, "purpose": "string", "settings": {}, "credentials": {}, "baseUrl": null, "goal": "string", "domain": "string", "description": "string", "credential": null, "direction": null, "senderKey": "string", "sender": "string" }'

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
tool
purpose
string
settings
object
credentials
object
baseUrl
goal
string
domain
string
description
string
credential
direction
senderKey
string
sender
string

Example

{  "tool": null,  "purpose": "string",  "settings": {},  "credentials": {},  "baseUrl": null,  "goal": "string",  "domain": "string",  "description": "string",  "credential": null,  "direction": null,  "senderKey": "string",  "sender": "string"}

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

Media typeapplication/json
One of:
One of:
object
title
required
string
connectionId
required
string
key
required
string
Allowed values: none sealed
reads
required
number
actions
required
number
proved
required
number
jobs
required
Array<object>
object
connectionId
string
proved
number
job
required
string
Allowed values: logs.read identity.read errors.read dns.records flags.switch security.read logs.intake hosts.deploy cloud.read messages.send tickets.write alerts.read support.read firewall.block payments.read
parts
required
Array<object>
object
needs
Array<string>
undoProved
One of:
boolean
undo
One of:
string
part
required
string
operation
required
string
missing
required
Array<string>
tried
required
Array<string>
next
required
string
goal
required
object
goal
required
string
parts
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: read act
words
required
string
why
required
string
undo
required
One of:
string
missing
required
Array<object>
object
part
required
string
why
required
string
unfound
required
Array<string>
by
required
string
Allowed values: none model
said
required
string
asked
required
string
met
required
boolean
whole
required
boolean
tool
required
string

Example

{  "title": "string",  "connectionId": "string",  "key": "none",  "reads": 1,  "actions": 1,  "proved": 1,  "jobs": [    {      "connectionId": "string",      "proved": 1,      "job": "logs.read",      "parts": [        {          "needs": [            "string"          ],          "undoProved": true,          "undo": "string",          "part": "string",          "operation": "string"        }      ],      "missing": [        "string"      ]    }  ],  "tried": [    "string"  ],  "next": "string",  "goal": {    "goal": "string",    "parts": [      {        "id": "string",        "kind": "read",        "words": "string",        "why": "string",        "undo": "string"      }    ],    "missing": [      {        "part": "string",        "why": "string"      }    ],    "unfound": [      "string"    ],    "by": "none",    "said": "string"  },  "asked": "string",  "met": true,  "whole": true,  "tool": "string"}

Started: the answer says where to follow it.

Media typeapplication/json
One of:
One of:
object
jobs
required
Array<object>
object
connectionId
string
proved
number
job
required
string
Allowed values: logs.read identity.read errors.read dns.records flags.switch security.read logs.intake hosts.deploy cloud.read messages.send tickets.write alerts.read support.read firewall.block payments.read
parts
required
Array<object>
object
needs
Array<string>
undoProved
One of:
boolean
undo
One of:
string
part
required
string
operation
required
string
missing
required
Array<string>
tried
required
Array<string>
next
required
string
asked
required
string
met
required
boolean
tool
required
string

Example

{  "jobs": [    {      "connectionId": "string",      "proved": 1,      "job": "logs.read",      "parts": [        {          "needs": [            "string"          ],          "undoProved": true,          "undo": "string",          "part": "string",          "operation": "string"        }      ],      "missing": [        "string"      ]    }  ],  "tried": [    "string"  ],  "next": "string",  "asked": "string",  "met": true,  "tool": "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.