Submitting a Manuscript

Endpoint: POST https://www.reviewerzero.ai/api/v1/reviews

Content-Type: multipart/form-data

Input (one required)

Provide either file or url, but not both.

Optional Fields

All sub-flags require run_integrity_report=true to take effect. When omitted, a flag falls to your organization's analysis defaults (set by an organization admin under Organization settings), then to the default in this table. You do not need to send every flag -- only include the ones you want to override; a flag you send always wins.

An organization admin can also mark a setting as not changeable. Omit that parameter and the request runs with the organization's value (the one shown in Organization settings, which can differ from the default in this table); send a different value and the request is rejected with 400 and error: "setting_locked", listing the parameters concerned. This applies to run_integrity_report, run_peer_review, run_journal_recommendations, notify_email and every run_* check flag, and only when the request is scoped to an organization with x-organization-id. Email and auto-delete are fixed only when the organization chose an explicit on or off for them; a fixed auto-delete then applies to reviews created through the API as well.

Peer-Review Fields

These require run_peer_review=true (the default), not run_integrity_report.

Sending either one with run_peer_review=false is rejected with 400, as is sending venue_guidelines together with run_submission_guidelines=false.

Checking Against Your Own Guidelines

target_venue names a venue and the guidelines check looks up that venue's published instructions. Send venue_guidelines instead when the rules are not on the web, or when you need the same rule set applied to every submission: the check then evaluates the document against exactly the Markdown you send and does not search.

Send one or the other. A request carrying both is rejected with 400.

curl -X POST https://www.reviewerzero.ai/api/v1/reviews \
  -H "Authorization: Bearer rz_abc123def456" \
  -F "file=@abstract.pdf" \
  -F "venue_guidelines=<conference-guidelines.md" \
  -F "run_peer_review=true"

Guidelines that already number their rules (R1, R2, section numbers) produce one finding per numbered rule, in the order they appear, so results stay comparable across submissions. Freeform prose is decomposed into checkable rules instead.

Rules that govern the submission process rather than the document -- a cover letter, suggested reviewers, an ORCID or account requirement, a fee or licence -- cannot be evidenced by the manuscript, so they are reported as unknown (rule_is_met: null) with a reason saying to verify them outside the document, rather than as violations.

A revision (revision_of) inherits the parent review's guidelines source -- either the supplied rules or the named venue -- so you do not need to resend it; both runs are then checked against the same rules. Sending venue_guidelines or target_venue on the revision overrides what it inherits. A revision that disables the guidelines check (run_submission_guidelines=false, or run_peer_review=false) inherits neither, so it is never billed for a check it did not ask for.

Because there is no venue name to report, targetJournalOrConference stays null in the response and the guidelines section reads "Checked against the guidelines you provided."

Example Request -- File Upload (cURL)

curl -X POST https://www.reviewerzero.ai/api/v1/reviews \
  -H "Authorization: Bearer rz_abc123def456" \
  -H "x-organization-id: org_publisher_acme" \  # optional
  -F "file=@manuscript.pdf" \
  -F "callback_url=https://your-system.example.com/callbacks/reviewerzero" \
  -F "run_integrity_report=true" \
  -F "run_peer_review=true"

Example Request -- URL Submission (cURL)

curl -X POST https://www.reviewerzero.ai/api/v1/reviews \
  -H "Authorization: Bearer rz_abc123def456" \
  -F "url=https://arxiv.org/pdf/2301.00001" \
  -F "callback_url=https://your-system.example.com/callbacks/reviewerzero"

When using url, ReviewerZero downloads the PDF server-side. The URL must be publicly accessible, return a Content-Type of application/pdf, and the file must not exceed the maximum upload size.

Response

{
  "review_id": "proj_a1b2c3d4e5"
}

Store the review_id to correlate with the callback you will receive later.