Skip to content

Draw a tile again from its own read, now

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/board/tiles/{id}/read
curl --request GET \  --url https://api.xovris.ai/v1/board/tiles/example/read \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
One of:
object
tile
required
object
id
required
string
form
required
string
title
required
string
door
required
string
args
required
object
key
additional properties
One of:
string
x
required
number
y
required
number
w
required
number
h
required
number
from
required
One of:
string
pinnedAt
required
string
at
required
string
read
required
One of:
object
ok
required
boolean
nodes
required
Array<object>
object
name
required
string
kind
required
string
ports
required
number
up
required
number
points
required
Array<object>
object
at
required
string
inBps
required
number
outBps
required
number
use
required
One of:
number

Example

{  "tile": {    "id": "string",    "form": "string",    "title": "string",    "door": "string",    "args": {},    "x": 1,    "y": 1,    "w": 1,    "h": 1,    "from": "string",    "pinnedAt": "string"  },  "at": "string",  "read": {    "ok": true,    "nodes": [      {        "name": "string",        "kind": "string",        "ports": 1,        "up": 1,        "points": [          {            "at": "string",            "inBps": 1,            "outBps": 1,            "use": null          }        ]      }    ]  }}

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.