API docs by Redocly

AI Literature Review API (1.0.0)

Download OpenAPI specification:

Public API for creating and managing AI literature review jobs.

The AI Literature Review API accepts a research question, sources papers from configured literature providers, and generates a Markdown review report. Long-running work is modeled as a review job.

Internal artifacts such as sourcing manifests, raw S3 artifact URIs, and structured result JSON are intentionally not part of this public contract.

Literature Reviews

Create, inspect, cancel, and download literature review jobs.

Create a literature review

Creates a review job and starts the literature review workflow. If query is omitted, the sourcing service can use the configured search_query_model to plan a keyword-based source search query from question. If query is provided, LLM query planning is skipped and the provided query is used after deterministic normalization.

Authorizations:
bearerAuth
header Parameters
Idempotency-Key
string [ 1 .. 256 ] characters

Optional idempotency key for safely retrying create requests.

Request Body schema: application/json
required
question
required
string non-empty

Natural-language research question to answer.

query
string non-empty

Optional source search query. When provided, LLM search-query planning is skipped.

sources
Array of strings (Source) non-empty
Default: ["openalex","pubmed","semantic_scholar"]
Items Enum: "openalex" "pubmed" "semantic_scholar"
object (SourcingOptions)

Literature sourcing controls.

object (SearchQueryModel)

LLM configuration used to plan a keyword-based source search query when query is omitted.

object (ReportModel)

LLM and embedding model configuration used by report generation.

object (ReportOptions)

Report generation controls.

Responses

Request samples

Content type
application/json
Example
{
  • "question": "What biomarkers predict response to immune checkpoint inhibitors in melanoma?",
  • "query": "melanoma immune checkpoint inhibitor response biomarkers",
  • "sources": [
    ],
  • "sourcing_options": {
    },
  • "search_query_model": {
    },
  • "report_model": {
    },
  • "report_options": {
    }
}

Response samples

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

List literature reviews

Lists the authenticated caller's review jobs, newest first.

Authorizations:
bearerAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 25

Maximum number of reviews to return.

Responses

Response samples

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

Get a literature review

Returns job status, request metadata, progress, warnings, errors, and public artifact metadata. Internal artifacts and raw storage URIs are not returned.

Authorizations:
bearerAuth
path Parameters
review_id
required
string non-empty
Example: lr-a3e0d1e2-6dba-4d6a-b9fc-ba50f6047530

Literature review identifier.

Responses

Response samples

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

Get review result metadata

Returns public result metadata after the review succeeds. This endpoint does not inline report contents and does not expose internal manifest or structured result JSON artifacts.

Authorizations:
bearerAuth
path Parameters
review_id
required
string non-empty
Example: lr-a3e0d1e2-6dba-4d6a-b9fc-ba50f6047530

Literature review identifier.

Responses

Response samples

Content type
application/json
{
  • "review_id": "lr-a3e0d1e2-6dba-4d6a-b9fc-ba50f6047530",
  • "status": "succeeded",
  • "artifacts": {
    }
}

Get report download URL

Returns a short-lived pre-signed URL for downloading the Markdown report. If the returned URL expires, call this endpoint again to request a fresh URL.

Authorizations:
bearerAuth
path Parameters
review_id
required
string non-empty
Example: lr-a3e0d1e2-6dba-4d6a-b9fc-ba50f6047530

Literature review identifier.

Responses

Response samples

Content type
application/json
{}

Cancel a literature review

Requests cancellation of a review. Terminal reviews and reviews already being canceled are returned unchanged. For running workflows, the service stops the workflow before marking the review as canceled.

Authorizations:
bearerAuth
path Parameters
review_id
required
string non-empty
Example: lr-a3e0d1e2-6dba-4d6a-b9fc-ba50f6047530

Literature review identifier.

Responses

Response samples

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