Documentation Index
Fetch the complete documentation index at: https://docs.tattoo.dev/llms.txt
Use this file to discover all available pages before exploring further.
TattooOS API: Industry Knowledge Overview
This document provides a comprehensive overview of the key concepts, roles, and workflows within the tattoo industry. Understanding these fundamentals is crucial for designing, building, and using the TattooOS API effectively. Our goal is to model the real world accurately, providing developers with the tools to create powerful, intuitive applications for artists, studios, and clients.Core Concepts
The tattoo industry is built around a few core concepts that our API is designed to handle:- Personas: The different roles people play in the industry.
- Styles: The artistic styles of tattoos.
- Appointments: The process of booking and managing tattoo sessions.
- Studios and Ownership: The business structures of tattoo shops.
- Rates and Transactions: How artists and studios get paid.
- Clients and Health: The information needed to safely tattoo a client.
- Experience and Travel: The career progression and mobility of artists.
- Products: The items sold and used in the tattoo process.
1. Personas
Our API recognizes several key personas, each with different needs and permissions.| Persona | Description | Relevance to API |
|---|---|---|
| Front Desk | Staff responsible for greeting clients, managing walk-ins, and handling initial inquiries. | read-only access to appointments, create access for walk-in clients. |
| Booking Manager | A hybrid sales/appointment setter role. Manages artist schedules and client relations. | create/update access to bookings, client records, and artist availability. |
| Independent Artist | A solo artist, often traveling or working for themselves. | Full control over their own portfolio, schedule, and client list. |
| Studio Artist | An artist employed by or renting a chair at a studio. | Access to their own schedule and portfolio, possibly with studio-level oversight. |
| Studio Owner | Manages the business side of a tattoo studio. | admin access over all studio-related data: artists, clients, bookings, financials. |
| Partner/Co-owner | Shares ownership and management responsibilities. | Similar to Studio Owner, with potentially shared admin privileges. |
| Traveling Artist | An artist who works at various studios for short periods (guest spots). | Needs to manage a dynamic schedule across multiple locations. |
2. Tattoo Styles
Tattoo styles are the lifeblood of an artist’s portfolio and a key factor in a client’s decision-making process. Our API treats styles as a first-class object, allowing for powerful search and discovery.Popular Styles
- Black and Grey Realism
- Realism
- American Traditional
- Japanese Traditional
- Traditional
- Neo-Traditional
- Tribal
- Watercolor
- New School
- Script/Lettering
Slang and Terminology
- Guest Spot: A temporary work arrangement for a traveling artist at a studio.
- Flash: Pre-designed tattoos, often displayed in a studio for walk-in clients.
- Sleeve: A large tattoo or collection of tattoos that covers most or all of a person’s arm.
- Dotwork: A shading technique using fine dots.
- Blackout: A tattoo style that involves covering a large area of skin with solid black ink.
- Healing: The recovery process after a tattoo session.
3. Appointments and Bookings
The appointment is the central event in the tattoo lifecycle. Our API provides a flexible system for managing different types of bookings.Booking Types
- Full Day: A flat-rate booking for a full day of tattooing.
- Half Day: A flat-rate booking for a half day.
- Hourly: A booking with a rate charged per hour.
Appointment Data
A booking object in our API will contain the following information:- Client Information: Name, age, contact details.
- Artist and Studio: The selected artist and studio.
- Tattoo Details: Placement on the body, reference photos, description of the desired work.
- History: Information about the client’s previous tattoos.
4. Studios and Ownership
Our API supports various business models, from solo artists to multi-location brands.- Studio: The primary business entity. A studio has a location, a roster of artists, and a client list.
- Studio Owner: The individual(s) with top-level control over the studio’s data and operations.
- Partners/Co-owners: Multiple individuals can have ownership-level permissions.
5. Rates and Transactions
Monetization is at the core of our API. We provide the tools to handle various payment scenarios.Rate Types
- Full Day Rate
- Half Day Rate
- Hourly Rate
Payment Types and Methods
- Deposits: A partial payment to secure a booking.
- Full Payment: The final payment for a completed tattoo.
- Financing: Integration with services like Klarna and Afterpay.
- Payment Methods: Our API can generate deposit links, integrate with Stripe, and create invoices.
6. Client Information, Skin, and Health
Client safety and informed consent are paramount. Our API includes objects for managing sensitive client data securely.Client Data
- Personal Information: Name, age, contact details.
- Tattoo History: Previous tattoos, artists, and studios.
- Preferences: Preferred artists and styles.
Skin and Health
- Skin Tone and Pigmentation: Important considerations for tattoo design and ink selection.
- Artist Public Health: Our API can store and display an artist’s credentials, such as:
- Blood Borne Pathogen training certification.
- State licenses.
- Years of experience.
7. Artist Experience and Travel
An artist’s career is a journey. Our API helps manage their progression and mobility.Experience Levels
- Senior Artist: A highly experienced and skilled artist.
- Apprentice: An artist in training.
- Junior Apprentice: An early-stage apprentice.
Travel and Guest Spots
- Guest Spot: A temporary work engagement at a different studio.
- Home Studio: An artist’s primary place of work.
- Availability: Our API allows artists to manage their schedules, including travel dates and availability for guest spots.
8. Products and Anesthesia
Beyond the tattoo itself, studios and artists often sell products and offer pain management solutions.Aftercare Products
- Lotions
- Ointments
- Healing Balms
Anesthesia
- Topical Anesthetics
- Numbing Creams