Technical setup guide
Connect CarPixAI through MCP
Active Business and Growth dealerships can create MCP-only keys under Dashboard → Integrations. This stateless Streamable HTTP endpoint uses a bearer header and dealership-scoped tools.
Endpoint and authentication
https://carpixai.com/api/mcp
Authorization: Bearer YOUR_MCP_KEYMCP keys are separate from REST keys, shown once, stored as a secret hash, limited to MCP transport, expire after 365 days, and can be revoked immediately. Keep them in server-side or MCP-client secret storage—not browser code or source control.
Client configuration
{
"mcpServers": {
"carpixai": {
"url": "https://carpixai.com/api/mcp",
"headers": {
"Authorization": "Bearer YOUR_MCP_KEY"
}
}
}
}Configuration field names vary by MCP client. Use a remote Streamable HTTP server with a custom Authorization header.
Tools
get_accountReturn the authenticated dealership and current image-credit balance.
list_background_templatesList uploaded background templates assigned to the authenticated dealership.
list_background_stylesList enabled dealer-safe CarPixAI styles without exposing internal prompts.
photo_processSubmit one HTTPS vehicle-photo source, an idempotency key, explicit credit confirmation, and optional approved style/aspect ratio.
photo_process_batchQueue up to 10 HTTPS vehicle-photo sources with one batch identity, stable item IDs, bounded concurrency, and per-item results.
photo_status_readRead safe processing status, retryability, Integrity-state availability, and result availability for an owned image.
get_photo_jobCompatibility alias for photo_status_read.
photo_result_readReturn the authenticated CarPixAI result URL when the owned result is ready for delivery.
Processing contract
photo_process requires sourceImageUrl, idempotencyKey, and confirmCreditUse: true. The source must be HTTPS, decode as JPEG, PNG, or WebP, and stay within byte, pixel, redirect, timeout, and public-network limits.
photo_process_batch accepts 1–10 unique items, one batchIdempotencyKey, and confirmCreditUse: true. Each item needs a stable itemId and HTTPS source. CarPixAI prepares at most three items concurrently, preserves input order in the receipt, and reports accepted or failed status for every item so one failure does not hide the others.
Each accepted new item identity reserves one image credit. Repeating the same batch key and item ID with identical bytes returns the original job without another debit. Reusing that identity with different bytes or settings returns a conflict. Dispatch failures use the shared compensation path.
Both processing tools delegate to CarPixAI's canonical production-default pipeline. MCP does not accept arbitrary prompts, model names, local file paths, base64 image bodies, webhooks, or DMS publishing.
Private results
photo_status_read never returns raw storage URLs. When resultRetrievable is true, call photo_result_read, then fetch its URL with the same MCP Authorization header. The result route repeats dealership ownership and Vehicle Integrity distribution authorization and responds with Cache-Control: private, no-store.
Errors and retries
Authentication failures return HTTP 401 before protocol dispatch. Tool failures return a fixed MCP error without provider messages, prompts, credentials, or internal storage details. Retry processing with the same idempotency key only when the source and settings are unchanged.