Skip to content

Send a file for the Ask to read - a document, a sheet, a picture or a recording - and ask about it

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/assist/files/read
curl --request POST \  --url https://api.xovris.ai/v1/assist/files/read \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

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

Example generated

{}

Done.

Media typeapplication/json
object
kept
required
boolean
words
string
read
required
object
kind
required
string
Allowed values: text image audio video docx xlsx pptx pdf csv
name
required
One of:
string
mediaType
required
string
bytes
required
number
count
required
number
unit
required
string
Allowed values: page line minute sheet slide
words
required
number
read
required
One of:
object
all
required
boolean
outline
required
Array<object>
object
level
required
number
text
required
string
where
required
string
tables
required
Array<object>
object
title
required
One of:
string
where
required
string
header
required
Array<string>
types
required
Array<string>
Allowed values: number text percent money date
rowCount
required
number
rows
required
Array<Array<string>>
tablesMore
required
number
answer
required
object
model
string
text
required
string
quoted
required
number
figures
required
number
question
required
One of:
string
by
required
string

Example

{  "kept": true,  "words": "string",  "read": {    "kind": "text",    "name": "string",    "mediaType": "string",    "bytes": 1,    "count": 1,    "unit": "page",    "words": 1,    "read": {      "all": true    },    "outline": [      {        "level": 1,        "text": "string",        "where": "string"      }    ],    "tables": [      {        "title": "string",        "where": "string",        "header": [          "string"        ],        "types": [          "number"        ],        "rowCount": 1,        "rows": [          [            "string"          ]        ]      }    ],    "tablesMore": 1  },  "answer": {    "model": "string",    "text": "string",    "quoted": 1,    "figures": 1,    "question": "string",    "by": "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.