---
title: "Documentation"
description: "Welcome to CarsXE API's documentation."
canonical_url: "https://docs.carsxe.com/docs"
markdown_url: "https://docs.carsxe.com/docs.md"
last_updated: "1980-01-01"
x_farming_labs_generated_preamble: true
agent:
  task: "Onboard a new CarsXE API customer through the dashboard wizard."
  outcome: "Following this page completes the Documentation task and produces the documented observable result."
  prerequisites:
    - "Access to the CarsXE account, credentials, and request inputs named on this page."
    - "The tools or client environment required by the Documentation procedure."
  verification:
    - "Complete the documented Documentation procedure and confirm the response or configuration matches the success criteria on this page."
  failureModes:
    - symptom: "The Documentation procedure fails or its result differs from the documented outcome."
      resolution: "Use the page's status-code or troubleshooting guidance to correct credentials, permissions, inputs, or configuration before retrying."
---

# Documentation
URL: /docs
LLM index: /llms.txt
Description: Welcome to CarsXE API's documentation.
Related: /docs/get-started, /docs/guides/agents, /docs/products/specifications

<!-- farming-labs:agent-contract:start -->
## Agent Contract

Task: Onboard a new CarsXE API customer through the dashboard wizard.
Outcome: Following this page completes the Documentation task and produces the documented observable result.

### Prerequisites

- Access to the CarsXE account, credentials, and request inputs named on this page.
- The tools or client environment required by the Documentation procedure.

### Verification

- Complete the documented Documentation procedure and confirm the response or configuration matches the success criteria on this page.

### Failure Modes

- The Documentation procedure fails or its result differs from the documented outcome. — Recovery: Use the page's status-code or troubleshooting guidance to correct credentials, permissions, inputs, or configuration before retrying.
<!-- farming-labs:agent-contract:end -->

Task: Onboard a new CarsXE API customer through the dashboard wizard.
Steps:
1. Sign in at https://carsxe.com/signin (or create an account).
2. Complete profile, usage survey, and payment method in the dashboard onboarding modal.
3. Copy the API key from Dashboard → Profile after activation.
Recovery: Click "Check onboarding" (bottom-right on docs or dashboard in dev) while signed in.
Related: /docs/get-started#quickstart, /docs/get-started#authentication, /docs/guides/agents

Learn everything there is to know about CarsXE API and integrate CarsXE into your product.

#### Getting started

To get started, [sign in or create an account](https://carsxe.com/signin) and grab an API key, then read about how to make requests for the resources you need to access using our HTTP APIs.

## Guides

<div className="grid sm:grid-cols-3 gap-4 mt-6">

<Card href="/docs/get-started">

### Quickstart

Get a quick start integrating the API into your application.

</Card>

<Card href="/docs/products">

### Products

Explore the full suite of vehicle data APIs available.

</Card>

<Card href="/docs/guides/organizations">

### Organizations

Share API access with your team using roles and organization API keys.

</Card>

<Card href="/docs/guides/errors">

### Errors

Read about the different types of errors returned by the API.

</Card>

<Card href="/docs/guides/rate-limits">

### Rate Limits & Quotas

Understand monthly quotas, 429 responses, and overage billing.

</Card>

<Card href="/docs/guides/agents">

### Agents & AI

Get an API key, read docs, and make calls — all from inside your AI agent.

</Card>

<Card href="/docs/guides/agentic-payments">

### Agentic Payments

Let agents pay for supported CarsXE API calls on demand with x402.

</Card>

</div>

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.
Docs-scoped sitemap: [/docs/sitemap.md](/docs/sitemap.md).
Well-known sitemap: [/.well-known/sitemap.md](/.well-known/sitemap.md).