Before you begin API access is available on Enterprise plans only. You must submit an access request and receive approval before generating access tokens. If you are not on an Enterprise plan, contact your Rayyan account representative.
Rayyan provides a full-featured API that lets you interact with your review data programmatically. A Python SDK is also available to make integration easier. Use the links below to get started:
- API access request form — ryn.ai/APIRequestForm
- HTTP API documentation — ryn.ai/rayyan-api-docs
- Python SDK — ryn.ai/sdk
How to generate your API access tokens
Once your access request is approved:
- Sign in to Rayyan and click your avatar in the top right corner.
- From the dropdown, select your name to open Account Details.
- Generate your personal API access tokens from this page.
To revoke or regenerate tokens manually at any time, navigate to rayyan.ai/users/edit while signed in.
Note Access tokens expire periodically for security reasons. Regenerate them from Account Details when needed.
Access is governed by
- Plan — your plan type determines which features are accessible via API
- Role — the permissions of your assigned role determine which API calls can be made successfully
- Throttling — API access is rate-limited to prevent misuse and manage requests
- Account — API access requires personally assigned access tokens generated from your account
Important Rayyan reserves the right to revoke API access in cases of misuse or abuse.
Comments
0 comments
Article is closed for comments.