Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt

Use this file to discover all available pages before exploring further.

Sandbox APIs follow semantic versioning to manage changes and ensure compatibility. This guide explains how versioning works and how to specify versions in your API requests.

ā€‹
Semantic versioning

Sandbox uses semantic versioning with the format MAJOR.MINOR.PATCH:
TypeCompatibilityExample
MajorBackward-incompatible changes1.0.0 ā†’ 2.0.0
MinorNew features, backward compatible2.0.0 ā†’ 2.1.0
PatchBug fixes, backward compatible2.1.0 ā†’ 2.1.1

ā€‹
Specifying API version

Use the x-api-version header to specify which version of the API you want to use: 
curl -X POST 'https://api.sandbox.co.in/endpoint' \
     -H 'x-api-key: YOUR_API_KEY' \
     -H 'authorization: YOUR_ACCESS_TOKEN' \
     -H 'x-api-version: 1.0'
API requests without the x-api-version header use the latest stable version.

ā€‹
Version lifecycle

ā€‹
Deprecation

When we release a new version, we may deprecate older versions. If you use a deprecated version:
  • You no longer receive active maintenance for it
  • It continues to work but receives no updates
  • You should migrate to a supported version
We communicate deprecation notices through:
  • Changelog
  • E-Mail notifications
  • API reference documentation

ā€‹
Discontinuation

Deprecated APIs are eventually discontinued after a planned transition period. After discontinuation:
  • API requests return 503 Service Unavailable
  • You must migrate to the newer version
We announce discontinuation dates through:
  • Changelog updates
  • E-Mail notifications to affected accounts
  • Warnings in API reference pages
Sandbox APIs always use the latest version, and previous versions are inaccessible. The x-api-version header only affects response format for specific endpoints that support version-specific responses.