API Documentation

Welcome to the ClickSet API documentation. This API allows you to manage users, API keys, datasets, and more. The API is organized around REST principles and uses standard HTTP response codes, authentication, and verbs.

Base URL

All API requests should be made to the following base URL:

https://api.clickset.ai/api/v1

Content Type

All requests and responses use JSON format. Requests should include the header:

Content-Type: application/json

API Versioning

The API is versioned using URL path versioning. The current version is v1. Future versions will be accessible at /api/v2, /api/v3, etc.

Authentication

The API uses two authentication methods:

• Cookie-based authentication for browser clients
• API key authentication for server-to-server communication

See the Authentication section for more details.

CORS Support

The API supports Cross-Origin Resource Sharing (CORS) to allow requests from different domains. See the CORS Support section for details on how to make cross-origin requests.

Public Datasets

The API supports public datasets, which can be accessed by any authenticated user without requiring explicit permissions. See the Public Datasets section for more information.

Rate Limits

To ensure the stability and performance of the API, rate limits are applied to all endpoints. The current rate limits are:

• Authentication endpoints: 10 requests per minute per IP address
• Standard endpoints: 60 requests per minute per authenticated user
• Public dataset endpoints: 120 requests per minute per authenticated user

If you exceed these rate limits, you will receive a 429 Too Many Requests response. The response will include a Retry-After header indicating how many seconds to wait before making another request.