Resources
Run in Postman
Postman is a popular tool that simplifies API testing and development. To help developers integrating with the Copyleaks APIs, we’ve created a Postman collection that covers all available API calls. This document will guide you through setting up the collection and making requests.
🚀 Get Started
Section titled “🚀 Get Started”-
Fork the Copyleaks Postman Collection
Section titled “Fork the Copyleaks Postman Collection”- Sign up or log in to your account on Postman
- Click the button below to access the Copyleaks Postman collection:
- Select Fork Collection
- Name your fork and select a workspace
-
Authenticate Your API Requests
Section titled “Authenticate Your API Requests”- To make API calls, you need to authenticate:
- Find your API Key in the API Dashboard
- In Postman, select your fork of the Copyleaks collection
- Go to the Variables tab and enter the following values in the CURRENT VALUE column:
- email:
YOUR_EMAIL_ADDRESS
- key:
YOUR_API_KEY
- email:
- Save the changes
- After logging in, check the response for the
access_token
- Take the value of the
access_token
and place it in the Authorization tab of your fork in Postman as the value of Token. All endpoints will inherit this token from the parent and will use it for authentication automatically
- To make API calls, you need to authenticate:
-
Make API Calls
Section titled “Make API Calls”You can now start making API requests.
For example, to run an AI detection scan:
- In your Postman workspace, navigate to your fork of the Copyleaks collection
- Select AI Detection > Submit Natural Language > Update the request body and add the scan ID, then click Send
- Review the response
🗺️ Next Steps
Section titled “🗺️ Next Steps” Copyleaks API in Postman Check out our Copyleaks API Postman Profile
Postman Collection Visit the complete Copyleaks API Postman Collection documentation
Account Documentation Learn how to authenticate and get started with Copyleaks APIs
Scans Methods Discover the full list of available Scans Methods Endpoints. Submit, start, and manage plagiarism scans