> For the complete documentation index, see [llms.txt](https://docs.carbonmark.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.carbonmark.com/carbonmark-api/quickstart.md).

# Quickstart

## Latest stable version

[https://v19.api.carbonmark.com](https://v19.api.carbonmark.com/)

## Use your preferred API client

The examples in these docs use `curl`, but you can follow the same workflow in any API client, including Postman, Insomnia, Bruno, or your own HTTP tooling.

If your client supports OpenAPI imports, you can import the Carbonmark OpenAPI spec and authenticate using your API key as a Bearer token.

The workflow remains the same:

1. Retrieve a listing price source from `/prices`
2. Create a quote with `/quotes`
3. Create an order with `/orders`
4. Confirm completion by querying `/orders` with the `quote_uuid`

## Getting started

1. Create an account or sign in with your existing Carbonmark account in the [Developer Dashboard](https://developers.carbonmark.com/login).
2. Once logged in, visit the [Keys](https://developers.carbonmark.com/dashboard/keys) page to generate a free sandbox API key.
3. Review the [API reference](https://api.carbonmark.com/) and guides for available endpoints and workflows.
4. [Contact Carbonmark](https://share-eu1.hsforms.com/1RWJWvyrHT1C_an4cZOHH3gfhhlr) when you are ready for production access and onboarding.

{% content-ref url="/pages/rOXfIFwLRhsqxJicKxjb" %}
[Versioning & Release Process](/carbonmark-api/versioning-and-release-process.md)
{% endcontent-ref %}

{% content-ref url="/pages/GhffJyxYkU82lU0er6G3" %}
[Retire Carbon](/carbonmark-api/retire-carbon.md)
{% endcontent-ref %}

## Explore projects

You can use the Carbonmark REST API to view assets, prices, supply, and other variables.

{% content-ref url="/pages/eT5gmNLlKHw14n7RvCFD" %}
[Explore Carbon Projects](/carbonmark-api/explore-carbon-projects.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.carbonmark.com/carbonmark-api/quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.