# Tillcast | Documentation Instructions for AI Agents: - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tillcast.com/_mcp/server ## Docs - [Welcome to Tillcast](https://docs.tillcast.com/welcome.md): Tillcast is a print API for receipt printers, for software vendors. The API, the dashboard, the status page and the TypeScript and Python SDKs are live. - [Quickstart](https://docs.tillcast.com/quickstart.md): Sign up, create an API key, add a customer, a location and a Star or Epson printer, send a first job and read its status. - [Create a print job](https://docs.tillcast.com/create-a-print-job.md): How to create a Tillcast print job with cURL, TypeScript or Python: the request and its fields, the 201 answer, reading the job, retrying with an idempotency key, the usual refusals, and receipts to copy. - [Integrate a point of sale](https://docs.tillcast.com/integrate-a-pos.md): How a point of sale sends a print job: key, printer, idempotency, your own order id, and what to do when something goes wrong. - [Provision a venue from your software](https://docs.tillcast.com/provision-a-venue.md): Set up a venue through the Tillcast API: customer, location and printer with your own ids, safe retries, a lost answer, the printer URL and the first test page. - [SDKs](https://docs.tillcast.com/getting-started/sdks.md): Install the Tillcast SDK for TypeScript (@tillcast/sdk) or Python (tillcast) and send a first job. - [Preview a receipt in your app](https://docs.tillcast.com/preview-a-receipt.md): Show a Tillcast receipt in a web page: install @tillcast/preview, give it blocks or ReceiptLine text, and it draws the receipt as it would print on 80 mm paper, in the browser, with no call to Tillcast. - [Concepts overview](https://docs.tillcast.com/concepts/overview.md): The Tillcast hierarchy of organization, customer, location, printer and job, and how a printer connects. - [Printer URL](https://docs.tillcast.com/concepts/printer-url.md): The Tillcast printer URL format, what its customer code and secret mean, how to treat it as a password, and how to move or replace a printer. - [Jobs](https://docs.tillcast.com/concepts/jobs.md): Tillcast job states, lifetime and limits, and what delivery means for a Star and for an Epson printer. - [Receipt documents](https://docs.tillcast.com/concepts/documents.md): How to write a Tillcast receipt document with blocks: text, rows and tables, rules, barcodes, QR codes and images. ReceiptLine text is the advanced way. - [Your own IDs](https://docs.tillcast.com/concepts/client-reference-id.md): The client_reference_id field of customers, locations, printers and jobs: not unique, optional, searchable. - [Suspension and pause](https://docs.tillcast.com/concepts/suspension.md): How Tillcast stops printing for a location, a customer or an organization, and what happens to waiting jobs. - [Authentication and API keys](https://docs.tillcast.com/api/authentication.md): How Tillcast API keys work. Every key is restricted, has explicit scopes and is created in the dashboard. - [Versioning](https://docs.tillcast.com/api/versioning.md): How Tillcast API versions work: the dated Tillcast-Version header, what counts as a breaking change, 6 months' notice before one, and 12 months for an old version date. - [Idempotency](https://docs.tillcast.com/api/idempotency.md): How the Idempotency-Key header lets you retry the creation of a job, a printer, a location or a customer safely. - [Errors](https://docs.tillcast.com/api/errors.md): How the Tillcast API reports errors, with status codes, error codes and request ids. - [Pagination](https://docs.tillcast.com/api/pagination.md): How lists in the Tillcast API are paged with limit, starting_after and ending_before. - [Rate limits and retention](https://docs.tillcast.com/api/rate-limits.md): The limits of the Tillcast API, job limits and retention periods. - [Webhooks and events](https://docs.tillcast.com/events/webhooks.md): The planned webhooks and events API of Tillcast, signed with Standard Webhooks. Not built yet. - [Supported printers](https://docs.tillcast.com/printers/supported-printers.md): Tillcast supports Star CloudPRNT and Epson Server Direct Print. Example models, firmware, and what has run on a device. - [Printer setup checklist](https://docs.tillcast.com/printers/setup-checklist.md): A short checklist for installing a Star or an Epson printer with a Tillcast printer URL. - [Set up a Star printer](https://docs.tillcast.com/printers/star-setup.md): How to enter a Tillcast printer URL in a Star printer's CloudPRNT settings, and what has been checked on a real printer. - [Set up an Epson printer](https://docs.tillcast.com/printers/epson-setup.md): How to add an Epson printer to Tillcast, enter the printer URL in the Server Direct Print settings of its Web Config and check its line width on paper, and what has and has not been checked on a device. - [Profiles and print options](https://docs.tillcast.com/printers/profiles.md): The printer profiles of Tillcast, which one a printer gets by default or from its paper width, how to set a profile and print options, and how far each profile has been checked on a real printer. - [First connection](https://docs.tillcast.com/printers/first-connection.md): The welcome receipt a Star printer prints when it first connects to Tillcast, and how to print a test page on a Star or an Epson printer. - [Troubleshooting](https://docs.tillcast.com/printers/troubleshooting.md): What to check when a Star or an Epson printer does not connect to Tillcast or does not print. - [Security and data](https://docs.tillcast.com/security.md): Where Tillcast data lives, how long it is kept and how organizations are kept apart. A description of the design, not an audit report. - [Status and incidents](https://docs.tillcast.com/status.md): The Tillcast status page at status.tillcast.com: the services it shows, how availability is measured and what to do during an incident. - [Connect an AI assistant (MCP)](https://docs.tillcast.com/connect-an-ai-assistant.md): How to connect an AI coding assistant to the Tillcast MCP server with an API key: the address, the setup for Claude Code, Codex CLI, Gemini CLI, Cursor, VS Code, Zed and Claude custom connectors, which key to give, what the tools do, safety and troubleshooting. OAuth sign-in is planned, not available. - [Build with an agent](https://docs.tillcast.com/build-with-an-agent.md): How a coding agent reads the Tillcast docs, an AGENTS.md snippet and prompts for planning and building a Tillcast integration, and why it must not call the live API to test: every key is live and prints on a real printer. - [Roadmap](https://docs.tillcast.com/roadmap.md): What is live in Tillcast today, what is in development and not available, what is planned and what is only an idea. No dates. - [Changelog](https://docs.tillcast.com/changelog/llms.txt) ## API Docs - [List customers](https://docs.tillcast.com/api-reference/customers/list.md): API reference > Customers - [Create a customer](https://docs.tillcast.com/api-reference/customers/create.md): API reference > Customers - [Retrieve a customer](https://docs.tillcast.com/api-reference/customers/get.md): API reference > Customers - [Delete a customer](https://docs.tillcast.com/api-reference/customers/delete.md): API reference > Customers - [Update a customer](https://docs.tillcast.com/api-reference/customers/update.md): API reference > Customers - [Reactivate a customer](https://docs.tillcast.com/api-reference/customers/reactivate.md): API reference > Customers - [Suspend a customer](https://docs.tillcast.com/api-reference/customers/suspend.md): API reference > Customers - [List the locations of a customer](https://docs.tillcast.com/api-reference/locations/list-for-customer.md): API reference > Locations - [Create a location](https://docs.tillcast.com/api-reference/locations/create.md): API reference > Locations - [List locations](https://docs.tillcast.com/api-reference/locations/list.md): API reference > Locations - [Retrieve a location](https://docs.tillcast.com/api-reference/locations/get.md): API reference > Locations - [Delete a location](https://docs.tillcast.com/api-reference/locations/delete.md): API reference > Locations - [Update a location](https://docs.tillcast.com/api-reference/locations/update.md): API reference > Locations - [Resume a location](https://docs.tillcast.com/api-reference/locations/reactivate.md): API reference > Locations - [Pause a location](https://docs.tillcast.com/api-reference/locations/suspend.md): API reference > Locations - [List the printers of a customer](https://docs.tillcast.com/api-reference/printers/list-for-customer.md): API reference > Printers - [List the printers of a location](https://docs.tillcast.com/api-reference/printers/list-for-location.md): API reference > Printers - [Add a printer](https://docs.tillcast.com/api-reference/printers/create.md): API reference > Printers - [List printers](https://docs.tillcast.com/api-reference/printers/list.md): API reference > Printers - [Retrieve a printer](https://docs.tillcast.com/api-reference/printers/get.md): API reference > Printers - [Delete a printer](https://docs.tillcast.com/api-reference/printers/delete.md): API reference > Printers - [Update a printer](https://docs.tillcast.com/api-reference/printers/update.md): API reference > Printers - [Move a printer](https://docs.tillcast.com/api-reference/printers/move.md): API reference > Printers - [Rotate a printer's secret](https://docs.tillcast.com/api-reference/printers/rotate-secret.md): API reference > Printers - [Print a test page](https://docs.tillcast.com/api-reference/printers/test-print.md): API reference > Printers - [List jobs](https://docs.tillcast.com/api-reference/jobs/list.md): API reference > Jobs - [Retrieve a job](https://docs.tillcast.com/api-reference/jobs/get.md): API reference > Jobs - [Cancel a job](https://docs.tillcast.com/api-reference/jobs/cancel.md): API reference > Jobs - [Create a job](https://docs.tillcast.com/api-reference/jobs/create.md): API reference > Jobs - [Retrieve your organization](https://docs.tillcast.com/api-reference/organization/get.md): API reference > Organization ## OpenAPI Specification - [OpenAPI JSON](https://docs.tillcast.com/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format - [OpenAPI YAML](https://docs.tillcast.com/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format