Skip to main content
Welcome to the Charp.ai API Reference. This section provides detailed endpoint documentation, request/response schemas, and interactive examples for every available API.

​
Authentication

Before calling any API, you need to obtain an access token using your client credentials. The token is passed as a Bearer token in the Authorization header of all subsequent requests.

Create Access Token

Authenticate with your client_id and client_secret to receive a Bearer token

​
Available APIs

Batch Media API

Create, manage, and monitor large-scale media generation tasks for batch campaigns

Realtime Media API

Trigger on-the-fly personalized media generation from apps or chatbots in real time

Virtual Try-On API

Enable AI-powered virtual garment try-on experiences with model and garment images

​
Endpoint Overview

​
Authorization API

MethodEndpointDescription
POST/auth/tokenObtain an access token using client credentials

​
Batch Media API

MethodEndpointDescription
POST/media/task/createCreate a new batch media generation task
POST/media/task/cancel/{taskId}Cancel an in-progress batch task
GET/media/task/status/{taskId}Check the status of a batch task

​
Realtime Media API

MethodEndpointDescription
POST/media/demoGenerate personalized media in real time
GET/status/{transactionId}Check the status of a realtime media request

​
Virtual Try-On API

MethodEndpointDescription
POST/vton/requestSubmit a virtual try-on request with model and garment images
GET/vton/status/{requestId}Retrieve the status and output of a try-on request

​
Common Response Codes

CodeDescription
200Request was successful
400Bad request — invalid or missing parameters
401Unauthorized — invalid or expired token

​
Need Help?

If you need integration support, reach out to us at support@whilter.ai.