API Reference

Getting Started

Setting up account and authentication.

Account Initialization

To begin using the CartAI APIs, please:

Request Access: Contact the CartAI Account Management Team to complete the required account verification and to provision your API access credentials. Click here to register for demo and access.


API Key Security Mandates

It is mandatory to adhere to the following security guidelines to protect your account integrity:

Confidentiality: Treat your API Keys as highly sensitive information. Never share them publicly.

Storage : Store your Secret API Key using a secure, dedicated environment variable or a secrets manager on your backend infrastructure.

Client-Side Prohibition: You must not hardcode, embed, or expose the Secret API Key in any client-side code, mobile application, or public repository. Failure to comply may result in key revocation.



Authenticating API Requests

All requests to the CartAI API must be authenticated using the x-api-key header.

**Header Requirement: ** Pass the provided API Key in the request header named x-api-key for every API call.