API docs by Redocly

Opscidia App (3.6.2)

Download OpenAPI specification:Download

Welcome to Opscidia API documentation. 🚀

Here you can find all available endpoints to do awesome stuff with Opscidia.

Terms of Service

info

Version

Authorizations:
APIAuth

Responses

Opscidia Search API

Get article

Retrieve detailed information about a specific article by its ID. Optionally, you can request the article to be translated.

Authorizations:
APIAuth
path Parameters
id
required
string (Id)
query Parameters
translate
boolean (Translate)
Default: false

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "abstract": "string",
  • "tldr": "string",
  • "citation": 0,
  • "URLs": [],
  • "custom_publication_date": "2025-09-10",
  • "doi": "10.1038/sdata.2020.1",
  • "DOI_origin": "crossref",
  • "authors": [
    ],
  • "authorship": [ ],
  • "chapter": "Chapter 1",
  • "editor": "John Doe",
  • "issue": "1",
  • "type": "journal-article",
  • "volume": "1",
  • "pages": "1-2",
  • "published_print": "2025-09-10",
  • "container_title": "",
  • "authors_affiliations": [ ],
  • "references": [ ],
  • "openalex_id": "",
  • "created": "2025-09-10",
  • "publisher": "Nature Publishing Group",
  • "bibtex": "@article{}",
  • "apa": "",
  • "mla": "",
  • "iso690": "",
  • "OA": [],
  • "domain": [ ],
  • "highlights": {
    },
  • "bookmarked": false,
  • "owner": "Organization name",
  • "adder": "John Doe",
  • "new": false,
  • "patent_id": "",
  • "patent_type": "",
  • "fetch_date": "2025-09-10",
  • "wipo_kind": "",
  • "patent_applicant": [ ],
  • "patent_applicant_organization": [ ],
  • "cpc_sequence": "",
  • "cpc_section": "",
  • "cpc_class": "",
  • "cpc_subclass": "",
  • "cpc_group": "",
  • "cpc_type": "",
  • "source": "from_es",
  • "feed_id": 0,
  • "image": "string",
  • "report_suitable": true,
  • "ncomments": 0,
  • "reactions": { },
  • "reference": "string",
  • "abstract_fr": "string",
  • "tldr_fr": "string"
}

Get article's references

Retrieve the list of references for a specific article by its ID. You can paginate the results using the offset and limit parameters.

Authorizations:
APIAuth
path Parameters
id
required
string (Id)
query Parameters
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 5

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "articles": [
    ]
}

Import Pdf

Import a PDF file as the full text of an article. This endpoint allows you to upload a PDF and associate it with an article by its ID.

Authorizations:
APIAuth
path Parameters
id
required
string (Id)
Request Body schema: multipart/form-data
required
pdf_file
required
string <binary> (Pdf File)

Responses

Response samples

Content type
application/json
null

Opscidia Report Assistant

Create report

Create a new report for a specified project. You can specify the report type and whether to return the created report instance or a list of reports.

Authorizations:
APIAuth
query Parameters
instance
boolean (Instance)
Default: true
Request Body schema: application/json
required
title
required
string (Title)

Report title

type
string (Type)
Default: "extractive"
Enum: "extractive" "generative"

Report type

project
integer (Project)

Project id

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type": "extractive",
  • "project": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "type": "extractive",
  • "project": 0,
  • "name": "string",
  • "author_username": "Jdoe",
  • "author_first_name": "John",
  • "author_last_name": "Doe",
  • "nbibliography": 0,
  • "created": "2024-05-23T15:49:43.292140",
  • "edited": "2024-05-23T15:49:43.292154",
  • "privacy": "private",
  • "initialled": false,
  • "step": "bib"
}

Update report

Update an existing report by its ID. You can only update the report title.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
Request Body schema: application/json
required
title
required
string (Title)

Report title

type
string (Type)
Default: "extractive"
Enum: "extractive" "generative"

Report type

project
integer (Project)

Project id

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type": "extractive",
  • "project": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "type": "extractive",
  • "project": 0,
  • "name": "string",
  • "author_username": "Jdoe",
  • "author_first_name": "John",
  • "author_last_name": "Doe",
  • "nbibliography": 0,
  • "created": "2024-05-23T15:49:43.292140",
  • "edited": "2024-05-23T15:49:43.292154",
  • "privacy": "private",
  • "initialled": false,
  • "step": "bib"
}

Delete report

Delete an existing report by its ID. Optionally, return a list of reports if the deletion is successful.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
query Parameters
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 5
search
string (Search)
Default: ""
instance
boolean (Instance)
Default: true
Enum: true false

Return instance message or list of reports

project
integer (Project)

If instance is False, this parameter may be used to filter by project

owned
boolean (Owned)
Default: true
Enum: true false

If instance is False, this parameter may be used to filter by ownership

Responses

Response samples

Content type
application/json
{
  • "message": "An error occured",
  • "message_fr": "Une erreur est survenue"
}

Get bibliography of report

Retrieve the bibliography of a specified report by its ID. You can paginate the results using the offset and limit parameters.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
query Parameters
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 5

Responses

Response samples

Content type
application/json
{
  • "report": 0,
  • "title": "string",
  • "project": 0,
  • "count": 0,
  • "owned": false,
  • "extra": { },
  • "articles": [
    ]
}

Get bibliography of generative report

Retrieve the bibliography of a specified generative report by its ID. You can paginate the results using the offset and limit parameters.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
query Parameters
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 5

Responses

Response samples

Content type
application/json
null

Add articles to generative report

Add articles to a generative report by its ID. You must specify either instances or offset and limit.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
query Parameters
instances
boolean (Instances)
Default: true
division
string (Division)
Default: "abstract"
offset
integer (Offset)
limit
integer (Limit)
Request Body schema: application/json
required
ids
required
Array of strings (Ids)

Responses

Request samples

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

Response samples

Content type
application/json
null

Remove article from generative report

Remove an article from the bibliography of a generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
article_id
required
string (Article Id)
query Parameters
division
string (Division)
Default: "abstract"
offset
integer (Offset)
Default: 0
limit
integer (Limit)
Default: 5

Responses

Response samples

Content type
application/json
null

Get sections of generative report

Retrieve the sections of a specified generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "sections": [
    ]
}

edit section's title of generative report

Edit the title of a section in a generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
query Parameters
section_id
required
string (Section Id)
Request Body schema: application/json
required
required
Title (string) or Title (integer) (Title)

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "message": "An error occured",
  • "message_fr": "Une erreur est survenue"
}

Add section to generative report

Add a new section to a generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
query Parameters
before
required
string (Before)

Responses

Response samples

Content type
application/json
{
  • "index": 0,
  • "title": "string",
  • "genre": "null",
  • "cluster_id": "string",
  • "editorState": { },
  • "editorLatest": true,
  • "map_clusters": [ ],
  • "articles": [
    ],
  • "section_title": "abstract"
}

Remove section from generative report

Remove a section from a generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
section_id
required
string (Section Id)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "sections": [
    ]
}

revise sections of generative report

Revise the sections of a generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "sections": [
    ]
}

Generate sections of generative report

Generate sections of a generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)

Responses

Response samples

Content type
application/json
{
  • "message": "An error occured",
  • "message_fr": "Une erreur est survenue"
}

translate generative report

Translate a generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
query Parameters
lang
string (Lang)

Responses

Response samples

Content type
application/json
null

Export report

Export a generative report by its ID.

Authorizations:
APIAuth
path Parameters
report_id
required
integer (Report Id)
Request Body schema: application/json
required
editorState
object (Editorstate)

Editor state for this cluster

Responses

Request samples

Content type
application/json
{
  • "editorState": { }
}

Response samples

Content type
application/json
null

Opscidia Ecosystem charts API

Get Ecosystem charts

Our opscidia Ecosystem charts API allows you to retrieve custom ecosystem charts based on the provided query parameters.

Authorizations:
APIAuth
query Parameters
keywords
string (Keywords)

Keywords to search

graph
string (Graph)

Graph type

x_axis
string (X Axis)

X axis

y_axis
string (Y Axis)
Default: "count"

Y axis

breakdown
string (Breakdown)

Breakdown

size
integer (Size)
Default: 10

Top N

review
string (review)
Default: "all_articles"
Enum: "all_articles" "has_review" "no_review"

all_articles: all articles, has_review: only articles with review, no_review: only articles without review

date_start
integer (Date Start)

Since year

date_end
integer (Date End)

Since year

fetch_start
string (start fetch)

Filter articles fetched from this date (YYYY-MM-DD)

fetch_end
string (end fetch)

Filter articles fetched to this date (YYYY-MM-DD)

page_start
integer (start page) >= 0
Default: 0

Pagination start

page_end
integer (end page) [ 1 .. 1000 ]
Default: 10

Pagination end. page_end + page_start <= 1000

oa
boolean (OA)
Default: false

True: only Open Acess articles, False: all articles

sorting
string (Sorting) >= 2 characters
Default: "relevance"
Enum: "relevance" "citation" "recent" "old"
news
boolean (news)
Default: false

True: news articles first, False: sorting order

citation_min
integer (min citation)

Filter articles with at least this number of citations. If not specified, the default is unknown

citation_max
integer (max citation)

Filter articles with at most this number of citations. If not specified, the default is unlimited

relevance_min
number (min relevance)

Filter articles with at least this 2**relevance-1. If not specified, the default is 0.3

relevance_max
number (max relevance)

Filter articles with at most this 2**relevance-1. If not specified, the default is infinite

registers
Array of strings (registers)
Items Enum: "arxiv" "crossref" "medrxiv" "biorxiv" "pubmed"

List of registers to search in. If not specified, the default is all

domain_in
Array of strings (domain)
Items Enum: "Agricultural And Food Sciences" "Art" "Biology" "Business" "Computer Science" "Chemistry" "Economics" "Education" "Engineering" "Environmental Science" "Geography" "Geology" "History" "Law" "Linguistics" "Materials Science" "Mathematics" "Medicine" "Philosophy" "Physics" "Political Science" "Psychology" "Sociology" "Statistics" "Electrical Engineering and Systems Science" "Quantitative Biology" "Quantitative Finance"

List of domains to must be included in search. If not specified, the default is all

domain_out
Array of strings (domain)
Items Enum: "Agricultural And Food Sciences" "Art" "Biology" "Business" "Computer Science" "Chemistry" "Economics" "Education" "Engineering" "Environmental Science" "Geography" "Geology" "History" "Law" "Linguistics" "Materials Science" "Mathematics" "Medicine" "Philosophy" "Physics" "Political Science" "Psychology" "Sociology" "Statistics" "Electrical Engineering and Systems Science" "Quantitative Biology" "Quantitative Finance"

List of domains to must be execluded in search. If not specified, the default is all

journals
Array of strings (journals)

List of journals to search in. If not specified, the default is all

institutions
Array of strings (institutions)

List of institutions to search in. If not specified, the default is all

countries
Array of strings (countries)

List of countries to search in. If not specified, the default is all

patent
string (patent)
Enum: "has_patent" "no_patent"

has_patent: only articles with the type patent, no_patent: only articles with a type diffrent than patent

unroll
string (unroll)
Default: "simple"
Enum: "simple" "complete" 
    Unroll the articles with (complete) or without (simple) the individual user data.
    **It is strongly recommended to use the simple unroll for fast API processing.**

Responses

Response samples

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