Skip to main content
API docs by Redocly

Biolevate API (1.0.0)

Download OpenAPI specification:Download

Agent

Conversational agent jobs

List agent jobs

Returns a paginated list of agent jobs for the current user, ordered by creation time (most recent first). When conversationId is provided, the results are restricted to jobs attached to that conversation, which lets a client replay the sequence of questions asked in a single conversation.

Authorizations:
TOKEN
query Parameters
pageSize
required
integer <int32>

Page size

page
required
integer <int32>

Page number (0-based)

conversationId
string <uuid>

Restrict the results to jobs attached to this conversation

Responses

Create agent job

Schedules an asynchronous agent run and returns the initial Job (status PENDING).

Authorizations:
TOKEN
header Parameters
Idempotency-Key
string
Request Body schema: application/json
required
message
string

Stateful mode: the new user message for this turn. Prior turns are loaded server-side from conversationId. Mutually exclusive with messages.

Array of objects (AgentInput)
object (FilesInput)

Files the agent can read from

object (JobLaunchConfig)

Optional job launch behaviour for input files

historyInputValid
boolean
conversationIdValid
boolean
output_model_schema
object (JsonNode)

Optional JSON Schema constraining the agent's final answer to a structured object. Free-form: any valid JSON Schema is accepted

object (AgentCompletionConfig)

Per-completion LLM knobs (model preset, temperature, max tokens)

max_iterations
integer <int32>

Hard cap on the number of agent-loop iterations

conversation_id
string <uuid>

Stateful only: continue an existing server session. Omit to start a new conversation. Must not be set for stateless runs.

Responses

Request samples

Content type
application/json
{
  • "message": "Summarize the attached report and list the main risks.",
  • "messages": [
    ],
  • "files": {
    },
  • "config": {
    },
  • "historyInputValid": true,
  • "conversationIdValid": true,
  • "output_model_schema": { },
  • "completion_config": {
    },
  • "max_iterations": 10,
  • "conversation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Get agent job

Returns a single agent job by its ID

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get agent job outputs

Returns the agent's answer (text or structured), explanation, and cited annotation ids

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get agent job inputs

Returns the messages, files and configuration submitted for the agent job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get agent job annotations

Returns the document annotations the agent cited in its answer

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Multi-Dimensional Extraction

Multi-dimensional (entity / schema-based) extraction resource management

List multi-dimensional extraction jobs

Returns a paginated list of multi-dimensional extraction jobs for the current user

Authorizations:
TOKEN
query Parameters
pageSize
required
integer <int32>

Page size

page
required
integer <int32>

Page number

sortProperty
string

Sort property

sortOrder
string

Sort order

Responses

Create multi-dimensional extraction job

Creates a new entity extraction job using a structured schema (multi-column) on the specified files

Authorizations:
TOKEN
Request Body schema: application/json
required
object (FilesInput)
object (EliseEntitySchemaInput)
object (JobLaunchConfig)

Optional job launch behaviour for input files

Responses

Request samples

Content type
application/json
{
  • "files": {
    },
  • "schema": {
    },
  • "config": {
    }
}

Get multi-dimensional extraction job

Returns a single multi-dimensional extraction job by its ID

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get multi-dimensional extraction job outputs

Returns the entity extraction results from the multi-dimensional extraction job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get multi-dimensional extraction job inputs

Returns the input files and entity schema used for the multi-dimensional extraction job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get multi-dimensional extraction job annotations

Returns the document annotations generated by the multi-dimensional extraction job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Find similar files

Find similar files locally and via remote bibliographic search

List find-similar jobs

Returns a paginated list of find-similar jobs owned by the current user.

Authorizations:
TOKEN
query Parameters
pageSize
required
integer <int32>

Page size

page
required
integer <int32>

Page number

sortProperty
string

Sort property

sortOrder
string

Sort order

Responses

Create find-similar job

Creates a find-similar job for the supplied source identifiers. The endpoint returns immediately with a PENDING/RUNNING job; poll GET /find-similar/jobs/{id} for completion.

Authorizations:
TOKEN
Request Body schema: application/json
required
Array of objects (SourceIdentifiers)
Array
doi
string
id
string
openAccessId
string

Responses

Request samples

Content type
application/json
{
  • "sourceIdentifiers": [
    ]
}

Get find-similar job

Returns a find-similar job by id, including the unified result and statistics when COMPLETED.

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job id

Responses

Providers

Storage provider management (read-only)

List providers

Returns a paginated list of storage providers the caller has access to. Secret fields are redacted.

Authorizations:
TOKEN
query Parameters
page
integer <int32>
Default: 0

Page number (0-based)

pageSize
integer <int32>
Default: 20

Page size

sortBy
string

Sort field

sortOrder
string
Default: "asc"

Sort direction (asc/desc)

q
string

Text search filter

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalPages": 0,
  • "totalElements": 0,
  • "hasNext": true
}

Get a provider

Returns a single storage provider by its ID. Secret fields are redacted.

Authorizations:
TOKEN
path Parameters
id
required
string

Provider ID

Responses

Response samples

Content type
application/json
{
  • "id": {
    },
  • "createdTime": 0,
  • "owner": {
    },
  • "policy": {
    },
  • "name": "string",
  • "icon": "string",
  • "config": {
    },
  • "type": "LOCAL",
  • "system": true
}

Question Answering

Question Answering resource management

List QA jobs

Returns a paginated list of question answering jobs for the current user

Authorizations:
TOKEN
query Parameters
pageSize
required
integer <int32>

Page size

page
required
integer <int32>

Page number

sortProperty
string

Sort property

sortOrder
string

Sort order

Responses

Create QA job

Creates a new question answering job on the specified files

Authorizations:
TOKEN
Request Body schema: application/json
required
object (FilesInput)
Array of objects (EliseQuestionInput)
object (JobLaunchConfig)

Optional job launch behaviour for input files

Responses

Request samples

Content type
application/json
{
  • "files": {
    },
  • "questions": [
    ],
  • "config": {
    }
}

Get QA job

Returns a single question answering job by its ID

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get QA job outputs

Returns the answers and results from the QA job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get QA job inputs

Returns the input files and questions used for the QA job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get QA job annotations

Returns the document annotations generated by the QA job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Extraction

Extraction resource management

List extraction jobs

Returns a paginated list of extraction jobs for the current user

Authorizations:
TOKEN
query Parameters
pageSize
required
integer <int32>

Page size

page
required
integer <int32>

Page number

sortProperty
string

Sort property

sortOrder
string

Sort order

Responses

Create extraction job

Creates a new metadata extraction job on the specified files

Authorizations:
TOKEN
Request Body schema: application/json
required
object (FilesInput)
Array of objects (EliseMetaInput)
object (JobLaunchConfig)

Optional job launch behaviour for input files

Responses

Request samples

Content type
application/json
{
  • "files": {
    },
  • "metas": [
    ],
  • "config": {
    }
}

Get extraction job

Returns a single extraction job by its ID

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get extraction job outputs

Returns the extracted metadata results from the job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get extraction job inputs

Returns the input files and meta configurations used for the extraction job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Get extraction job annotations

Returns the document annotations generated by the extraction job

Authorizations:
TOKEN
path Parameters
jobId
required
string

The job Id

Responses

Provider Items

File and folder operations on storage providers

List items

Returns a paginated list of files and folders in the specified directory

Authorizations:
TOKEN
path Parameters
providerId
required
string

Provider ID

query Parameters
key
string
Default: ""

Directory key (must end with '/' or be empty for root)

q
string

Name filter

cursor
string

Pagination cursor

limit
integer <int32>
Default: 50

Max items to return

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "nextCursor": "string"
}

Create folder

Creates a new folder in the provider. Key must end with '/'.

Authorizations:
TOKEN
path Parameters
providerId
required
string

Provider ID

query Parameters
key
string
Default: ""

Target directory key (must end with '/' or be empty for root)

Request Body schema:
required
file
required
string <binary>

File to upload

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "providerId": "550e8400-e29b-41d4-a716-446655440000",
  • "key": "reports/document.pdf",
  • "type": "FILE",
  • "size": 1048576,
  • "extension": "pdf",
  • "mediaType": "application/pdf",
  • "lastModified": 1708123456789
}

Delete item

Deletes a file or folder

Authorizations:
TOKEN
path Parameters
providerId
required
string

Provider ID

Request Body schema: application/json
required
key
required
string

Full item key. Files: 'path/to/file.pdf', Folders: 'path/to/folder/'

Responses

Request samples

Content type
application/json
{
  • "key": "reports/document.pdf"
}

Rename item

Renames a file or folder

Authorizations:
TOKEN
path Parameters
providerId
required
string

Provider ID

query Parameters
newName
required
string

New name for the item

Request Body schema: application/json
required
key
required
string

Full item key. Files: 'path/to/file.pdf', Folders: 'path/to/folder/'

Responses

Request samples

Content type
application/json
{
  • "key": "reports/document.pdf"
}

Response samples

Content type
application/json
{
  • "providerId": "550e8400-e29b-41d4-a716-446655440000",
  • "key": "reports/document.pdf",
  • "type": "FILE",
  • "size": 1048576,
  • "extension": "pdf",
  • "mediaType": "application/pdf",
  • "lastModified": 1708123456789
}

Get presigned upload URL

Returns a presigned URL for direct upload to storage (for large files)

Authorizations:
TOKEN
path Parameters
providerId
required
string

Provider ID

Request Body schema: application/json
required
key
required
string

Full file key (must not end with '/')

size
integer <int64>

File size in bytes

mediaType
string

Media type

Responses

Request samples

Content type
application/json
{
  • "key": "reports/document.pdf",
  • "size": 1048576,
  • "mediaType": "application/pdf"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "expiresInSeconds": 0,
  • "supported": true
}

Confirm presigned upload

Confirms that a file was uploaded via presigned URL

Authorizations:
TOKEN
path Parameters
providerId
required
string

Provider ID

Request Body schema: application/json
required
key
required
string

Full file key (must not end with '/')

Responses

Request samples

Content type
application/json
{
  • "key": "reports/document.pdf"
}

Response samples

Content type
application/json
{
  • "providerId": "550e8400-e29b-41d4-a716-446655440000",
  • "key": "reports/document.pdf",
  • "type": "FILE",
  • "size": 1048576,
  • "extension": "pdf",
  • "mediaType": "application/pdf",
  • "lastModified": 1708123456789
}

Get download URL

Returns a URL to download the file

Authorizations:
TOKEN
path Parameters
providerId
required
string

Provider ID

query Parameters
key
required
string

File key (must not end with '/')

expirationMinutes
integer <int32>
Default: 15

URL expiration in minutes

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "expiresInSeconds": 0
}

Get file content

Returns the raw file content (proxy for providers without presigned URLs)

Authorizations:
TOKEN
path Parameters
providerId
required
string

Provider ID

query Parameters
key
required
string

File key (must not end with '/')

Responses

Files

EliseFile resource management

List files in a provider

Returns paginated file infos for a provider

Authorizations:
TOKEN
query Parameters
providerId
required
string

Provider ID

pageSize
required
integer <int32>

Page size

page
required
integer <int32>

Page number

sortProperty
string

Sort property

sortOrder
string

Sort order

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalPages": 0,
  • "totalElements": 0,
  • "hasNext": true
}

Create a file

Creates an EliseFile from an existing provider item and triggers indexation

Authorizations:
TOKEN
Request Body schema: application/json
required
providerId
required
string

Source provider ID

key
required
string

Full file key (must not end with '/')

Responses

Request samples

Content type
application/json
{
  • "providerId": "01a91a21-3136-4094-96da-ded4dce3824f",
  • "key": "documents/report.pdf"
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "createdTime": 0,
  • "owner": {
    },
  • "policy": {
    },
  • "providerId": {
    },
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "checksum": "string",
  • "mediaType": "string",
  • "extension": "string",
  • "indexed": true,
  • "matchComputed": true,
  • "displayName": "string",
  • "dbName": "string",
  • "lastIndexationInfos": {
    },
  • "ownerFirstName": "string",
  • "ownerLastName": "string",
  • "ownerEmail": "string",
  • "ownerAvatarUrl": "string",
  • "providerName": "string",
  • "additionalInfo": { },
  • "description": "string",
  • "authors": "string",
  • "title": "string",
  • "lastMergeJob": {
    },
  • "additionalInfos": { },
  • "type": "FILE"
}

Reindex a file

Forces reindexation of a file. Optionally reparses the document.

Authorizations:
TOKEN
path Parameters
id
required
string

File ID

query Parameters
reparse
boolean
Default: false

Reparse document content

Responses

Recompute file ontologies

Forces recomputation of ontologies and metadata for a file

Authorizations:
TOKEN
path Parameters
id
required
string

File ID

Responses

Get a file

Returns a file by its ID

Authorizations:
TOKEN
path Parameters
id
required
string

File ID

Responses

Response samples

Content type
application/json
{
  • "id": {
    },
  • "createdTime": 0,
  • "owner": {
    },
  • "policy": {
    },
  • "providerId": {
    },
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "checksum": "string",
  • "mediaType": "string",
  • "extension": "string",
  • "indexed": true,
  • "matchComputed": true,
  • "displayName": "string",
  • "dbName": "string",
  • "lastIndexationInfos": {
    },
  • "ownerFirstName": "string",
  • "ownerLastName": "string",
  • "ownerEmail": "string",
  • "ownerAvatarUrl": "string",
  • "providerName": "string",
  • "additionalInfo": { },
  • "description": "string",
  • "authors": "string",
  • "title": "string",
  • "lastMergeJob": {
    },
  • "additionalInfos": { },
  • "type": "FILE"
}

Delete a file

Deletes a file

Authorizations:
TOKEN
path Parameters
id
required
string

File ID

Responses

Get file ontologies

Returns computed ontologies for a file

Authorizations:
TOKEN
path Parameters
id
required
string

File ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Collections

Collection resource management

List collections

Returns a paginated list of collections the caller has access to

Authorizations:
TOKEN
query Parameters
page
integer <int32>
Default: 0

Page number (0-based)

pageSize
integer <int32>
Default: 20

Page size

sortBy
string

Sort field

sortOrder
string
Default: "asc"

Sort direction (asc/desc)

q
string

Text search filter

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalPages": 0,
  • "totalElements": 0,
  • "hasNext": true
}

Create a collection

Creates a new collection owned by the current user

Authorizations:
TOKEN
Request Body schema: application/json
required
name
required
string
description
string
icon
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "createdTime": 0,
  • "owner": {
    },
  • "policy": {
    },
  • "name": "string",
  • "description": "string",
  • "icon": "string",
  • "ownerFirstName": "string",
  • "ownerLastName": "string",
  • "ownerEmail": "string",
  • "ownerAvatarUrl": "string",
  • "filesCount": 0,
  • "derivedFromCollectionId": {
    },
  • "derivedFromCollectionName": "string",
  • "derivedFromViewId": {
    },
  • "derivedFromViewName": "string",
  • "chained": true,
  • "derivedToCollectionId": {
    },
  • "derivedToCollectionName": "string"
}

List files in collection

Returns a paginated list of files belonging to the collection

Authorizations:
TOKEN
path Parameters
id
required
string

Collection ID

query Parameters
page
integer <int32>
Default: 0

Page number (0-based)

pageSize
integer <int32>
Default: 20

Page size

sortBy
string

Sort field

sortOrder
string
Default: "asc"

Sort direction (asc/desc)

q
string

Text search filter

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "totalPages": 0,
  • "totalElements": 0,
  • "hasNext": true
}

Add file to collection

Associates an existing file with the collection

Authorizations:
TOKEN
path Parameters
id
required
string

Collection ID

Request Body schema: application/json
required
fileId
required
string

EliseFile ID to add to the collection

Responses

Request samples

Content type
application/json
{
  • "fileId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "createdTime": 0,
  • "owner": {
    },
  • "policy": {
    },
  • "providerId": {
    },
  • "name": "string",
  • "path": "string",
  • "size": 0,
  • "checksum": "string",
  • "mediaType": "string",
  • "extension": "string",
  • "indexed": true,
  • "matchComputed": true,
  • "displayName": "string",
  • "dbName": "string",
  • "lastIndexationInfos": {
    },
  • "ownerFirstName": "string",
  • "ownerLastName": "string",
  • "ownerEmail": "string",
  • "ownerAvatarUrl": "string",
  • "providerName": "string",
  • "additionalInfo": { },
  • "description": "string",
  • "authors": "string",
  • "title": "string",
  • "lastMergeJob": {
    },
  • "additionalInfos": { },
  • "type": "FILE"
}

Get a collection

Returns a single collection by its ID

Authorizations:
TOKEN
path Parameters
id
required
string

Collection ID

Responses

Response samples

Content type
application/json
{
  • "id": {
    },
  • "createdTime": 0,
  • "owner": {
    },
  • "policy": {
    },
  • "name": "string",
  • "description": "string",
  • "icon": "string",
  • "ownerFirstName": "string",
  • "ownerLastName": "string",
  • "ownerEmail": "string",
  • "ownerAvatarUrl": "string",
  • "filesCount": 0,
  • "derivedFromCollectionId": {
    },
  • "derivedFromCollectionName": "string",
  • "derivedFromViewId": {
    },
  • "derivedFromViewName": "string",
  • "chained": true,
  • "derivedToCollectionId": {
    },
  • "derivedToCollectionName": "string"
}

Delete a collection

Deletes a collection. Only the owner can delete a collection.

Authorizations:
TOKEN
path Parameters
id
required
string

Collection ID

Responses

Update a collection

Partially updates a collection. Only provided fields will be updated.

Authorizations:
TOKEN
path Parameters
id
required
string

Collection ID

Request Body schema: application/json
required
name
string
description
string
icon
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "icon": "string"
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "createdTime": 0,
  • "owner": {
    },
  • "policy": {
    },
  • "name": "string",
  • "description": "string",
  • "icon": "string",
  • "ownerFirstName": "string",
  • "ownerLastName": "string",
  • "ownerEmail": "string",
  • "ownerAvatarUrl": "string",
  • "filesCount": 0,
  • "derivedFromCollectionId": {
    },
  • "derivedFromCollectionName": "string",
  • "derivedFromViewId": {
    },
  • "derivedFromViewName": "string",
  • "chained": true,
  • "derivedToCollectionId": {
    },
  • "derivedToCollectionName": "string"
}

Remove file from collection

Removes the association between a file and the collection

Authorizations:
TOKEN
path Parameters
id
required
string

Collection ID

fileId
required
string

File ID

Responses