Skip to content

API Reference

REST-based

Gainly is based on REST and has predictable resource-oriented URLs. It uses standard HTTP verbs, authentication, and response codes.

Base URL

The base URL for your API requests is:

https://api.gainly.ai

This is the URL for both test mode and live mode. The API key used to authenticate an API request will determine whether that API request works in test mode or live mode.

JSON

Gainly uses JSON for request and response bodies.

No bulk actions

Gainly API doesn't support bulk add/update/delete actions. Each API request can only add/update/delete one object (such as a single document).

You can execute bulk actions using a simple batching mechanism with rate limiting.

Standards-compliant

Gainly is fully compliant with the open standards for APIs: OpenAPI and JSON Schema.

OpenAPI Spec