19

Use our docs with AI

You can use our documentation and API specifications with your AI tool of choice, making it easy to search and get answers from our docs right from your editor or other AI tools.

How it works

Large language models (LLMs) are great at reading markdown because, unlike HTML, there’s a lot less noise for them to parse. To make our documentation more accessible to AI, we’ve provided markdown-accessible versions of most of our documentation so you can reference it with your own AI tools.

You can access plain-text markdown versions of our docs in a few ways:

• (Recommended) Our llms.txt file: This is an emerging standard and acts as a sort of LLM-friendly sitemap. It provides links to our markdown files so your LLM can access markdown versions of our pages without having to download them.
• Download individual markdown pages: you can either use the download link in the sidebar or just append .md to the end of most URLs to get the markdown version of the page. You can add individual pages to your own knowledge base or use them as a reference for your LLM.
• Download our API specifications: our APIs are documented using the OpenAPI 3.0 standard, which LLMs typically understand. You can use them to build integrations with Customer.io.

Use the our llm sitemap

You can access or download our llms.txt file to help your LLM access, and provide answers based on, markdown versions of our documentation.

The llms.txt file is a flattened version of the sitemap for docs.customer.io based on an emerging standard for LLM-friendly documentation. While it’s still an early standard, it can be a handy way to get answers from our docs without having to open a new browser tab or download individual pages.

• Access our llms.txt file
• Learn more about the proposed llms.txt standard

Download plain text documentation

You can download or copy our documentation as plain text markdown files for use with your LLM of choice—you can even create your own GPTs and tools!

You can either use the dropdown on the right-side of our documentation or add .md to the end of (almost) any URL. For example, you can check out the markdown for this page at https://docs.customer.io/get-started/with-llms.md.

While you’re also welcome to use our HTML-rendered pages, plain text is generally easier for LLMs to handle than HTML because:

• Plain text contains fewer formatting tokens.
• Plain text shows content that may not be rendered in HTML, like content hidden in unselected tabs.
• LLMs can parse and understand markdown hierarchy.

Download OpenAPI specifications

You can download our OpenAPI specifications as JSON for help building integrations with Customer.io. Because these specifications are written in OpenAPI, they’re easy for LLMs to parse and understand.

• Pipelines API: Get data into Customer.io using an API similar to Segment and other CDPs. Most of our SDKs rely on this API.
• Track API: The classic way to bring data into Customer.io. Many partners rely on this API.
• App API: This is the API you would use if you wanted to build an “app” around Customer.io. From here, you can trigger broadcasts, send transactional messages, and get or update information about people, messages, etc.
• Webhooks API: Describes our endpoint to create a reporting webhook and all the events we’ll send to your webhook endpoint.

We also offer Postman collections that can help you try things out. You’ll find the postman collection for any of our APIs on the individual API pages.