{
    "openapi": "3.1.0",
    "info": {
        "title": "inuit Agency API",
        "version": "1.4.3",
        "summary": "Search and read the public content of www.inuit.agency.",
        "description": "Read-only HTTP API of the website of inuit Agency (inuit GmbH), a brand consultancy in Hamburg, Germany. No authentication. All operations are safe GET requests. The JSON API lives under /api/v1 and reports errors as application/problem+json (RFC 9457) with a stable \"code\" and a \"resolution\". Versioning: the version is part of the URL path, changes within a version are backwards compatible, breaking changes get a new version path. Before a version is retired, its responses carry the headers Deprecation (RFC 9745) and Sunset (RFC 8594) and the documentation states the date. The site guide at https://www.inuit.agency/llms.txt lists all pages. The same content is available through the MCP server at https://www.inuit.agency/mcp.",
        "contact": {
            "name": "inuit GmbH",
            "url": "https://www.inuit.agency/contact/",
            "email": "hamburg@inuit.agency"
        }
    },
    "externalDocs": {
        "description": "inuit Agency API documentation",
        "url": "https://www.inuit.agency/developers/"
    },
    "servers": [
        {
            "url": "https://www.inuit.agency",
            "description": "Production website"
        }
    ],
    "tags": [
        {
            "name": "api",
            "description": "JSON API, version v1"
        },
        {
            "name": "content",
            "description": "Pages, case studies and articles as Markdown"
        }
    ],
    "paths": {
        "/api/v1": {
            "get": {
                "operationId": "getApiIndex",
                "tags": [
                    "api"
                ],
                "summary": "API index",
                "description": "Returns the API version and the URLs of all endpoints, the documentation and the OpenAPI description.",
                "responses": {
                    "200": {
                        "description": "API index.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ApiIndex"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Invalid or unknown parameter. The field \"invalid_params\" names each parameter and the reason.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "405": {
                        "description": "Method not allowed. The API is read-only.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "Internal error.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api/v1/pages": {
            "get": {
                "operationId": "listPages",
                "tags": [
                    "api"
                ],
                "summary": "List pages, case studies and articles",
                "description": "Lists the public content with title, type and URLs. Use \"api_url\" of an item to read it as JSON.",
                "parameters": [
                    {
                        "name": "section",
                        "in": "query",
                        "required": false,
                        "description": "Which part of the site to list.",
                        "schema": {
                            "type": "string",
                            "enum": [
                                "all",
                                "pages",
                                "case_studies",
                                "articles"
                            ],
                            "default": "all"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "List of content items.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/PageList"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Invalid or unknown parameter. The field \"invalid_params\" names each parameter and the reason.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "405": {
                        "description": "Method not allowed. The API is read-only.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "Internal error.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api/v1/pages/{slug}": {
            "get": {
                "operationId": "getPage",
                "tags": [
                    "api"
                ],
                "summary": "Read one page or article as JSON",
                "description": "Returns one page or article with metadata and its full text as Markdown. Use the slug \"index\" for the homepage. Valid slugs are the last path segment of \"api_url\" in the list of pages.",
                "parameters": [
                    {
                        "name": "slug",
                        "in": "path",
                        "required": true,
                        "description": "Slug of the page or article, as in its URL path.",
                        "schema": {
                            "type": "string",
                            "pattern": "^[A-Za-z0-9_-]+$",
                            "maxLength": 200
                        },
                        "example": "solutions"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The page.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Page"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No public page with this slug (code \"page_not_found\").",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Invalid or unknown parameter. The field \"invalid_params\" names each parameter and the reason.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "405": {
                        "description": "Method not allowed. The API is read-only.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "Internal error.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api/v1/pages/portfolio/{slug}": {
            "get": {
                "operationId": "getCaseStudy",
                "tags": [
                    "api"
                ],
                "summary": "Read one case study as JSON",
                "description": "Returns one client case study with metadata and its full text as Markdown.",
                "parameters": [
                    {
                        "name": "slug",
                        "in": "path",
                        "required": true,
                        "description": "Slug of the case study, as in its URL path.",
                        "schema": {
                            "type": "string",
                            "pattern": "^[A-Za-z0-9_-]+$",
                            "maxLength": 200
                        },
                        "example": "xing"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The case study.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Page"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No public case study with this slug (code \"page_not_found\").",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Invalid or unknown parameter. The field \"invalid_params\" names each parameter and the reason.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "405": {
                        "description": "Method not allowed. The API is read-only.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "Internal error.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api/v1/search": {
            "get": {
                "operationId": "searchSite",
                "tags": [
                    "api"
                ],
                "summary": "Search pages, case studies and articles",
                "description": "Full-text search across the public content. Returns title, type, URLs and a short summary per hit.",
                "parameters": [
                    {
                        "name": "q",
                        "in": "query",
                        "required": true,
                        "description": "Search terms.",
                        "schema": {
                            "type": "string",
                            "minLength": 2,
                            "maxLength": 100
                        },
                        "example": "brand strategy"
                    },
                    {
                        "name": "limit",
                        "in": "query",
                        "required": false,
                        "description": "Maximum number of results.",
                        "schema": {
                            "type": "integer",
                            "minimum": 1,
                            "maximum": 10,
                            "default": 5
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Search results.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/SearchResults"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Invalid or unknown parameter. The field \"invalid_params\" names each parameter and the reason.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "405": {
                        "description": "Method not allowed. The API is read-only.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "Internal error.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/api/v1/contact": {
            "get": {
                "operationId": "getContact",
                "tags": [
                    "api"
                ],
                "summary": "Contact details",
                "description": "Returns company name, address, phone, email and official profiles.",
                "responses": {
                    "200": {
                        "description": "Contact details.",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Contact"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Invalid or unknown parameter. The field \"invalid_params\" names each parameter and the reason.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "405": {
                        "description": "Method not allowed. The API is read-only.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "Internal error.",
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/{slug}.md": {
            "get": {
                "operationId": "getPageMarkdown",
                "tags": [
                    "content"
                ],
                "summary": "Read a page or an article as Markdown",
                "description": "Returns one page or article as Markdown. Use the slug \"index\" for the homepage. Other valid slugs are listed in the site guide at /llms.txt, for example \"solutions\", \"about\", \"contact\" or \"case-studies\".",
                "parameters": [
                    {
                        "name": "slug",
                        "in": "path",
                        "required": true,
                        "description": "Slug of the page or article, as in its URL path.",
                        "schema": {
                            "type": "string",
                            "pattern": "^[a-z0-9-]+$",
                            "maxLength": 200
                        },
                        "example": "solutions"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Markdown document with YAML frontmatter (title, description, canonical, last-updated).",
                        "content": {
                            "text/markdown": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No public page at this path. The body explains the error in Markdown.",
                        "content": {
                            "text/markdown": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/portfolio/{slug}.md": {
            "get": {
                "operationId": "getCaseStudyMarkdown",
                "tags": [
                    "content"
                ],
                "summary": "Read a case study as Markdown",
                "description": "Returns one client case study as Markdown. Valid slugs are listed in the site guide at /llms.txt, for example \"xing\" or \"statista\".",
                "parameters": [
                    {
                        "name": "slug",
                        "in": "path",
                        "required": true,
                        "description": "Slug of the case study, as in its URL path.",
                        "schema": {
                            "type": "string",
                            "pattern": "^[a-z0-9-]+$",
                            "maxLength": 200
                        },
                        "example": "xing"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Markdown document with YAML frontmatter (title, description, canonical, last-updated).",
                        "content": {
                            "text/markdown": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "No public page at this path. The body explains the error in Markdown.",
                        "content": {
                            "text/markdown": {
                                "schema": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "Problem": {
                "type": "object",
                "description": "Error object as defined by RFC 9457 (Problem Details for HTTP APIs), extended by \"code\", \"resolution\" and \"documentation_url\".",
                "required": [
                    "type",
                    "title",
                    "status",
                    "detail",
                    "code",
                    "resolution"
                ],
                "properties": {
                    "type": {
                        "type": "string",
                        "description": "URI that identifies the kind of error and links to its documentation.",
                        "format": "uri"
                    },
                    "title": {
                        "type": "string",
                        "description": "Short summary of the kind of error."
                    },
                    "status": {
                        "type": "integer",
                        "description": "HTTP status code."
                    },
                    "detail": {
                        "type": "string",
                        "description": "Explanation of this occurrence."
                    },
                    "instance": {
                        "type": "string",
                        "description": "Path of the request that caused the error.",
                        "format": "uri-reference"
                    },
                    "code": {
                        "type": "string",
                        "enum": [
                            "invalid_parameter",
                            "not_found",
                            "page_not_found",
                            "route_not_found",
                            "method_not_allowed",
                            "internal_error"
                        ],
                        "description": "Stable machine-readable error code."
                    },
                    "resolution": {
                        "type": "string",
                        "description": "What the client can do to resolve the error."
                    },
                    "documentation_url": {
                        "type": "string",
                        "description": "Documentation of the error model.",
                        "format": "uri"
                    },
                    "invalid_params": {
                        "type": "array",
                        "description": "Present for code \"invalid_parameter\".",
                        "items": {
                            "type": "object",
                            "required": [
                                "name",
                                "reason"
                            ],
                            "properties": {
                                "name": {
                                    "type": "string",
                                    "description": "Name of the parameter."
                                },
                                "reason": {
                                    "type": "string",
                                    "description": "Why the value was rejected and which values are allowed."
                                }
                            }
                        }
                    }
                }
            },
            "ApiIndex": {
                "type": "object",
                "required": [
                    "name",
                    "version",
                    "documentation_url",
                    "openapi_url",
                    "endpoints"
                ],
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "Name of the API."
                    },
                    "version": {
                        "type": "string",
                        "description": "Current API version."
                    },
                    "description": {
                        "type": "string",
                        "description": "What the API offers."
                    },
                    "documentation_url": {
                        "type": "string",
                        "description": "Human-readable documentation.",
                        "format": "uri"
                    },
                    "openapi_url": {
                        "type": "string",
                        "description": "OpenAPI description.",
                        "format": "uri"
                    },
                    "site_guide_url": {
                        "type": "string",
                        "description": "Site guide for agents (llms.txt).",
                        "format": "uri"
                    },
                    "mcp_url": {
                        "type": "string",
                        "description": "MCP server with the same content.",
                        "format": "uri"
                    },
                    "endpoints": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "required": [
                                "method",
                                "url",
                                "summary"
                            ],
                            "properties": {
                                "method": {
                                    "type": "string",
                                    "description": "HTTP method."
                                },
                                "url": {
                                    "type": "string",
                                    "description": "URL of the endpoint. Braces mark path parameters."
                                },
                                "summary": {
                                    "type": "string",
                                    "description": "What the endpoint returns."
                                }
                            }
                        }
                    }
                }
            },
            "PageItem": {
                "type": "object",
                "required": [
                    "title",
                    "type",
                    "url",
                    "markdown_url",
                    "api_url"
                ],
                "properties": {
                    "title": {
                        "type": "string",
                        "description": "Title as plain text."
                    },
                    "type": {
                        "type": "string",
                        "enum": [
                            "page",
                            "article",
                            "case study"
                        ],
                        "description": "Kind of content."
                    },
                    "url": {
                        "type": "string",
                        "description": "URL of the HTML page.",
                        "format": "uri"
                    },
                    "markdown_url": {
                        "type": "string",
                        "description": "URL of the Markdown version.",
                        "format": "uri"
                    },
                    "api_url": {
                        "type": "string",
                        "description": "URL of this item in the JSON API.",
                        "format": "uri"
                    }
                }
            },
            "PageList": {
                "type": "object",
                "required": [
                    "section",
                    "count",
                    "items"
                ],
                "properties": {
                    "section": {
                        "type": "string",
                        "enum": [
                            "all",
                            "pages",
                            "case_studies",
                            "articles"
                        ]
                    },
                    "count": {
                        "type": "integer",
                        "description": "Number of items."
                    },
                    "items": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/PageItem"
                        }
                    }
                }
            },
            "Page": {
                "type": "object",
                "required": [
                    "title",
                    "type",
                    "url",
                    "markdown_url",
                    "api_url",
                    "markdown"
                ],
                "properties": {
                    "title": {
                        "type": "string",
                        "description": "Title as plain text."
                    },
                    "type": {
                        "type": "string",
                        "enum": [
                            "page",
                            "article",
                            "case study"
                        ],
                        "description": "Kind of content."
                    },
                    "url": {
                        "type": "string",
                        "description": "URL of the HTML page.",
                        "format": "uri"
                    },
                    "markdown_url": {
                        "type": "string",
                        "description": "URL of the Markdown version.",
                        "format": "uri"
                    },
                    "api_url": {
                        "type": "string",
                        "description": "URL of this item in the JSON API.",
                        "format": "uri"
                    },
                    "summary": {
                        "type": "string",
                        "description": "Short description of the page."
                    },
                    "last_updated": {
                        "type": "string",
                        "description": "Time of the last change (UTC).",
                        "format": "date-time"
                    },
                    "markdown": {
                        "type": "string",
                        "description": "Full text as Markdown with YAML frontmatter."
                    }
                }
            },
            "SearchResults": {
                "type": "object",
                "required": [
                    "query",
                    "count",
                    "results"
                ],
                "properties": {
                    "query": {
                        "type": "string",
                        "description": "The search terms as received."
                    },
                    "count": {
                        "type": "integer",
                        "description": "Number of results."
                    },
                    "results": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "required": [
                                "title",
                                "type",
                                "url",
                                "markdown_url",
                                "api_url"
                            ],
                            "properties": {
                                "title": {
                                    "type": "string",
                                    "description": "Title as plain text."
                                },
                                "type": {
                                    "type": "string",
                                    "enum": [
                                        "page",
                                        "article",
                                        "case study"
                                    ],
                                    "description": "Kind of content."
                                },
                                "url": {
                                    "type": "string",
                                    "description": "URL of the HTML page.",
                                    "format": "uri"
                                },
                                "markdown_url": {
                                    "type": "string",
                                    "description": "URL of the Markdown version.",
                                    "format": "uri"
                                },
                                "api_url": {
                                    "type": "string",
                                    "description": "URL of this item in the JSON API.",
                                    "format": "uri"
                                },
                                "summary": {
                                    "type": "string",
                                    "description": "Short description of the page."
                                }
                            }
                        }
                    }
                }
            },
            "Contact": {
                "type": "object",
                "required": [
                    "name",
                    "legal_name",
                    "address",
                    "website",
                    "contact_page"
                ],
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "Brand name."
                    },
                    "legal_name": {
                        "type": "string",
                        "description": "Legal name of the company."
                    },
                    "address": {
                        "type": "object",
                        "properties": {
                            "street": {
                                "type": "string",
                                "description": "Street and number."
                            },
                            "postal_code": {
                                "type": "string",
                                "description": "Postal code."
                            },
                            "city": {
                                "type": "string",
                                "description": "City."
                            },
                            "country": {
                                "type": "string",
                                "description": "ISO 3166-1 alpha-2 country code."
                            }
                        }
                    },
                    "telephone": {
                        "type": "string",
                        "description": "Phone number."
                    },
                    "email": {
                        "type": "string",
                        "description": "Email address.",
                        "format": "email"
                    },
                    "website": {
                        "type": "string",
                        "description": "Homepage.",
                        "format": "uri"
                    },
                    "contact_page": {
                        "type": "string",
                        "description": "Contact page with booking options.",
                        "format": "uri"
                    },
                    "profiles": {
                        "type": "array",
                        "items": {
                            "type": "string",
                            "format": "uri"
                        },
                        "description": "Official profiles."
                    },
                    "notes": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        },
                        "description": "Rules for agents that use these details."
                    }
                }
            }
        }
    }
}
