The Copyleaks API is a RESTful web service that uses HTTPS for secure communication. This guide provides a high-level overview of the core concepts you’ll need to understand to use the API effectively.

Generating Your API Key

Your API Key is the first step to authenticating with the Copyleaks API. The authentication process involves exchanging this key for a temporary Access Token, which is then used to make API requests.

For detailed instructions on how to generate your API key and authenticate, please see our complete Authentication Guide.

Content Types

The Copyleaks API uses the JSON format for both requests and responses. You must send the Content-Type: application/json header in your requests. Our official SDKs handle this for you automatically.

Submitting Content

Copyleaks can process content in several formats, depending on the endpoint you are using:

• Raw Text: Submit plain text directly in the request body.
• Base64 Encoded File: Submit a file by encoding its content into a Base64 string. The filename parameter, including the file extension, is used to determine the document type.
• URL: Provide a public URL to a document, and Copyleaks will crawl and process its content.

Request Size Limits

While there is no single global request size limit, specific endpoints have their own constraints. For text submissions, such as those to the AI Detector or Writing Assistant, there are character limits detailed on their respective pages. For file submissions, please refer to the Technical Specifications for detailed file size limits.

Rate Limiting

The Copyleaks API enforces rate limits to ensure fair usage and stability. The default rate limit is 10 requests per second, per user. However, specific endpoints may have different rate limits, which are detailed on their respective pages in the API reference.

If you send too many requests in a short period, you will receive a 429 Too Many Requests HTTP response. For more details, see our Technical Specifications.

If you require a higher rate limit, please contact our support team.

Sandbox Mode

For development and testing, we provide a sandbox mode that allows you to make API calls without consuming credits or affecting your production data. To use it, include the "sandbox": true parameter in your request. The exact location of this parameter may vary by endpoint, so please refer to the specific endpoint documentation in the API Reference or our guides for implementation details.

When in sandbox mode, the API will not perform a real scan, but will instead return mock data that simulates a real response. This allows you to test your integration and workflows without consuming credits.

Authentication Learn how to exchange your API key for an access token to make API calls.