{
  "openapi": "3.1.0",
  "info": {
    "title": "blogmate public API",
    "version": "1.0.0",
    "summary": "Pricing, the changelog, the blog, waitlist signup, and contact for blogmate, the automated blog-writing platform.",
    "description": "blogmate is an automated blog-writing platform. It researches keywords, writes a post in a company's own brand voice for its audience's level of awareness, and publishes one every day to build visibility on Google and in AI search (ChatGPT, Claude, Perplexity). Customers also join a backlink network that exchanges relevant links between their blogs.\n\nblogmate is pre-launch. This API covers what exists today on blogmate.ai: reading pricing, the changelog and the blog, joining the waitlist for a person who asked to join, and sending the team a message. The customer publishing API described at https://blogmate.ai/resources/docs ships with the product and is not part of this document.\n\n- **Authentication:** none. Every endpoint is public.\n- **Format:** JSON in and out, UTF-8. Request bodies are closed objects: send only the documented fields.\n- **Errors:** RFC 9457 problem details (`application/problem+json`) with a stable `code`, a `detail`, and a `hint` saying how to fix the request. `type` links to the code's documentation; `GET /api/errors` lists every code.\n- **Methods:** an unsupported method answers 405 with an `Allow` header, as problem+json.\n- **Rate limits:** none are published. The write endpoints send email to a person, so send one request per thing a person asked for.\n- **Pages:** every page of the site is also available as Markdown. Append `.md` to its URL (`https://blogmate.ai/index.md` for the home page) or request it with `Accept: text/markdown`. https://blogmate.ai/llms.txt maps them all.",
    "contact": {
      "name": "blogmate",
      "email": "info@blogmate.ai",
      "url": "https://blogmate.ai/contact"
    },
    "termsOfService": "https://blogmate.ai/terms",
    "license": {
      "name": "blogmate Terms of Service",
      "url": "https://blogmate.ai/terms"
    }
  },
  "servers": [
    {
      "url": "https://blogmate.ai",
      "description": "Production"
    }
  ],
  "security": [],
  "externalDocs": {
    "description": "llms.txt: the whole site, described for agents",
    "url": "https://blogmate.ai/llms.txt"
  },
  "tags": [
    {
      "name": "Product",
      "description": "What blogmate costs and what has shipped."
    },
    {
      "name": "Blog",
      "description": "blogmate's own blog: playbooks on SEO, AI search, and automated content."
    },
    {
      "name": "Waitlist",
      "description": "blogmate is pre-launch. The waitlist is the way in."
    },
    {
      "name": "Contact",
      "description": "Reach the team. A person replies by email."
    },
    {
      "name": "Meta",
      "description": "This API, described by itself."
    }
  ],
  "paths": {
    "/api": {
      "get": {
        "operationId": "getApiIndex",
        "tags": [
          "Meta"
        ],
        "summary": "List this API's endpoints",
        "description": "Every endpoint with its operationId, method, and absolute URL, plus links to this spec, llms.txt, the API catalog, and the error codes. Use it to discover the API without parsing the whole spec.",
        "responses": {
          "200": {
            "description": "The API index.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiIndex"
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/pricing": {
      "get": {
        "operationId": "getPricing",
        "tags": [
          "Product"
        ],
        "summary": "Get blogmate's pricing",
        "description": "The one plan's price per workspace (one blog on one site), monthly and billed yearly, in EUR excluding VAT, with its features, plus the custom-quoted agency arrangement. Use it to answer what blogmate costs. While blogmate is pre-launch, `availability` is `waitlist`: the price is what a spot will cost once one is offered.",
        "responses": {
          "200": {
            "description": "Current pricing.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pricing"
                },
                "example": {
                  "currency": "EUR",
                  "vatIncluded": false,
                  "availability": "waitlist",
                  "waitlistUrl": "https://blogmate.ai/waitlist",
                  "note": "This is what a spot will cost · Nothing to pay to join the list",
                  "plan": {
                    "id": "standard",
                    "name": "blogmate",
                    "tagline": "The whole product, for one site.",
                    "unit": "workspace",
                    "prices": {
                      "monthly": {
                        "perMonth": 100,
                        "billedEvery": "month",
                        "billedAmount": 100
                      },
                      "annual": {
                        "perMonth": 80,
                        "billedEvery": "year",
                        "billedAmount": 960,
                        "savingPercent": 20
                      }
                    },
                    "features": [
                      "A new post every day, published for you",
                      "Keyword research and competitor analysis",
                      "Brand voice and audience training",
                      "One workspace - one blog, on one site",
                      "Backlink network access",
                      "API access",
                      "Priority support"
                    ]
                  },
                  "agency": {
                    "name": "Agency",
                    "tagline": "For studios running a roster of client blogs.",
                    "price": "custom",
                    "priceNote": "Quoted on your roster size",
                    "features": [
                      "A workspace for every client site",
                      "Volume pricing across the roster",
                      "One account, one invoice",
                      "Shared team access across workspaces",
                      "Add or pause workspaces as accounts change",
                      "Onboarding for the whole book"
                    ],
                    "contactUrl": "https://blogmate.ai/contact"
                  },
                  "invoicing": "Invoiced in EUR via Stripe. iDEAL, card, SEPA accepted."
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/changelog": {
      "get": {
        "operationId": "listChangelogEntries",
        "tags": [
          "Product"
        ],
        "summary": "List changelog entries",
        "description": "Every meaningful change to blogmate, newest first: new features, improvements, and fixes.",
        "responses": {
          "200": {
            "description": "The changelog, newest first.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChangelogList"
                },
                "example": {
                  "entries": [
                    {
                      "title": "Foundations",
                      "version": "v0.1",
                      "date": "2026-01-01",
                      "category": "new",
                      "summary": "The groundwork for blogmate is live: accounts, team workspaces, and subscriptions - the platform the blog autopilot is being built on.",
                      "details": [
                        "Email/password and OAuth sign-in",
                        "Team workspaces with invites",
                        "Subscription billing and a customer portal powered by Stripe"
                      ]
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/posts": {
      "get": {
        "operationId": "listBlogPosts",
        "tags": [
          "Blog"
        ],
        "summary": "List blog posts",
        "description": "The posts published on blogmate's own blog, newest first, with links to each post's page and its Markdown. These are blogmate's articles about SEO and AI search, not posts blogmate wrote for customers.",
        "responses": {
          "200": {
            "description": "Published posts, newest first.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PostList"
                },
                "example": {
                  "posts": [
                    {
                      "slug": "ai-search-halved-the-clicks",
                      "title": "AI Overviews cut clicks in half. Write anyway.",
                      "excerpt": "Almost nobody clicks the citations inside an AI Overview, but the visitors who do arrive convert far better.",
                      "type": "explainer",
                      "typeLabel": "Explainer",
                      "publishedAt": "2026-08-18T09:00:00Z",
                      "readingTimeMinutes": 9,
                      "url": "https://blogmate.ai/blog/ai-search-halved-the-clicks",
                      "markdownUrl": "https://blogmate.ai/blog/ai-search-halved-the-clicks.md",
                      "author": {
                        "name": "blogmate"
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/posts/{slug}": {
      "get": {
        "operationId": "getBlogPost",
        "tags": [
          "Blog"
        ],
        "summary": "Get a blog post",
        "description": "One published post with its full body as Markdown, its dates, and related posts. Get slugs from listBlogPosts.",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "description": "The post's slug: the last segment of its URL.",
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200,
              "pattern": "^[^/]+$"
            },
            "example": "ai-search-halved-the-clicks"
          }
        ],
        "responses": {
          "200": {
            "description": "The post.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Post"
                }
              }
            }
          },
          "404": {
            "description": "No published post has that slug.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "post_not_found": {
                    "summary": "Post not found",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/post_not_found",
                      "title": "Post not found",
                      "status": 404,
                      "detail": "There is no published post with the slug no-such-post.",
                      "instance": "/api/posts/no-such-post",
                      "code": "post_not_found",
                      "hint": "List the published posts with GET https://blogmate.ai/api/posts.",
                      "ok": false,
                      "error": "There is no published post with the slug no-such-post."
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/waitlist": {
      "post": {
        "operationId": "joinWaitlist",
        "tags": [
          "Waitlist"
        ],
        "summary": "Join the waitlist for a person",
        "description": "Adds an email address to blogmate's pre-launch waitlist, double opt-in: blogmate emails the address a confirmation link, and it only counts once its owner clicks it. Call this only for a person who asked to join, with their own address. Repeating the call for the same address is safe: it never duplicates the signup and re-sends the link at most once every five minutes.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WaitlistSignup"
              },
              "example": {
                "email": "jane@company.com",
                "source": "agent"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The signup was accepted.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WaitlistResult"
                },
                "example": {
                  "ok": true,
                  "status": "created",
                  "message": "We've sent a link to that address. Click it and your spot is confirmed - until then you are not on the list yet."
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "invalid_json": {
                    "summary": "The request body is not valid JSON",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/invalid_json",
                      "title": "The request body is not valid JSON",
                      "status": 400,
                      "detail": "The request body is not valid JSON",
                      "instance": "/api/waitlist",
                      "code": "invalid_json",
                      "hint": "Send a JSON object with Content-Type: application/json.",
                      "ok": false,
                      "error": "The request body is not valid JSON"
                    }
                  },
                  "invalid_email": {
                    "summary": "The email address is not valid",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/invalid_email",
                      "title": "The email address is not valid",
                      "status": 400,
                      "detail": "The email address is not valid",
                      "instance": "/api/waitlist",
                      "code": "invalid_email",
                      "hint": "Send `email` as a string that looks like name@example.com, at most 254 characters.",
                      "ok": false,
                      "error": "The email address is not valid"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "The signup could not be completed. Nothing was saved.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "not_configured": {
                    "summary": "This endpoint is not configured on the server",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/not_configured",
                      "title": "This endpoint is not configured on the server",
                      "status": 500,
                      "detail": "This endpoint is not configured on the server",
                      "instance": "/api/waitlist",
                      "code": "not_configured",
                      "hint": "Nothing in the request can fix this. Try again later, or write to info@blogmate.ai.",
                      "ok": false,
                      "error": "This endpoint is not configured on the server"
                    }
                  },
                  "storage_failed": {
                    "summary": "The signup could not be stored",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/storage_failed",
                      "title": "The signup could not be stored",
                      "status": 500,
                      "detail": "The signup could not be stored",
                      "instance": "/api/waitlist",
                      "code": "storage_failed",
                      "hint": "Nothing was saved. Retry the same request in a minute.",
                      "ok": false,
                      "error": "The signup could not be stored"
                    }
                  },
                  "delivery_failed": {
                    "summary": "The email could not be sent",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/delivery_failed",
                      "title": "The email could not be sent",
                      "status": 500,
                      "detail": "The email could not be sent",
                      "instance": "/api/waitlist",
                      "code": "delivery_failed",
                      "hint": "Nothing was saved. Retry the same request in a minute; if it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "The email could not be sent"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/contact": {
      "post": {
        "operationId": "sendContactMessage",
        "tags": [
          "Contact"
        ],
        "summary": "Send the blogmate team a message",
        "description": "Delivers a message to the team's inbox; a person replies to `email`, usually within one business day. Use it for sales and agency pricing, partnerships, press, or questions this API and the site do not answer.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContactMessage"
              },
              "example": {
                "name": "Jane van der Berg",
                "email": "jane@company.com",
                "subject": "Agency pricing for 12 client blogs",
                "message": "We run blogs for twelve clients and would like a quote for the whole roster."
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The message was delivered.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ContactResult"
                },
                "example": {
                  "ok": true,
                  "message": "Thanks for reaching out. We'll reply to the email you provided, usually within one business day."
                }
              }
            }
          },
          "400": {
            "description": "The request was malformed.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "invalid_json": {
                    "summary": "The request body is not valid JSON",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/invalid_json",
                      "title": "The request body is not valid JSON",
                      "status": 400,
                      "detail": "The request body is not valid JSON",
                      "instance": "/api/contact",
                      "code": "invalid_json",
                      "hint": "Send a JSON object with Content-Type: application/json.",
                      "ok": false,
                      "error": "The request body is not valid JSON"
                    }
                  },
                  "invalid_name": {
                    "summary": "The name is missing or too long",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/invalid_name",
                      "title": "The name is missing or too long",
                      "status": 400,
                      "detail": "The name is missing or too long",
                      "instance": "/api/contact",
                      "code": "invalid_name",
                      "hint": "Send `name` as a non-empty string of at most 120 characters.",
                      "ok": false,
                      "error": "The name is missing or too long"
                    }
                  },
                  "invalid_email": {
                    "summary": "The email address is not valid",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/invalid_email",
                      "title": "The email address is not valid",
                      "status": 400,
                      "detail": "The email address is not valid",
                      "instance": "/api/contact",
                      "code": "invalid_email",
                      "hint": "Send `email` as a string that looks like name@example.com, at most 254 characters.",
                      "ok": false,
                      "error": "The email address is not valid"
                    }
                  },
                  "invalid_subject": {
                    "summary": "The subject is missing or too long",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/invalid_subject",
                      "title": "The subject is missing or too long",
                      "status": 400,
                      "detail": "The subject is missing or too long",
                      "instance": "/api/contact",
                      "code": "invalid_subject",
                      "hint": "Send `subject` as a non-empty string of at most 160 characters.",
                      "ok": false,
                      "error": "The subject is missing or too long"
                    }
                  },
                  "invalid_message": {
                    "summary": "The message is missing or too long",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/invalid_message",
                      "title": "The message is missing or too long",
                      "status": 400,
                      "detail": "The message is missing or too long",
                      "instance": "/api/contact",
                      "code": "invalid_message",
                      "hint": "Send `message` as a non-empty string of at most 4000 characters.",
                      "ok": false,
                      "error": "The message is missing or too long"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "The message could not be delivered.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "not_configured": {
                    "summary": "This endpoint is not configured on the server",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/not_configured",
                      "title": "This endpoint is not configured on the server",
                      "status": 500,
                      "detail": "This endpoint is not configured on the server",
                      "instance": "/api/contact",
                      "code": "not_configured",
                      "hint": "Nothing in the request can fix this. Try again later, or write to info@blogmate.ai.",
                      "ok": false,
                      "error": "This endpoint is not configured on the server"
                    }
                  },
                  "delivery_failed": {
                    "summary": "The email could not be sent",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/delivery_failed",
                      "title": "The email could not be sent",
                      "status": 500,
                      "detail": "The email could not be sent",
                      "instance": "/api/contact",
                      "code": "delivery_failed",
                      "hint": "Nothing was saved. Retry the same request in a minute; if it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "The email could not be sent"
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/errors": {
      "get": {
        "operationId": "listErrorCodes",
        "tags": [
          "Meta"
        ],
        "summary": "List the API's error codes",
        "description": "Every `code` an error response can carry, with its HTTP status, title, and a hint for fixing the request.",
        "responses": {
          "200": {
            "description": "All error codes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemTypeList"
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/errors/{code}": {
      "get": {
        "operationId": "getErrorCode",
        "tags": [
          "Meta"
        ],
        "summary": "Describe one error code",
        "description": "The documentation an error's `type` URL points at: its status, title, and how to fix the request.",
        "parameters": [
          {
            "name": "code",
            "in": "path",
            "required": true,
            "description": "An error code, as found in an error response's `code`.",
            "schema": {
              "$ref": "#/components/schemas/ErrorCode"
            },
            "example": "invalid_email"
          }
        ],
        "responses": {
          "200": {
            "description": "The error code's documentation.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemType"
                },
                "example": {
                  "type": "https://blogmate.ai/api/errors/invalid_email",
                  "code": "invalid_email",
                  "status": 400,
                  "title": "The email address is not valid",
                  "hint": "Send `email` as a string that looks like name@example.com, at most 254 characters."
                }
              }
            }
          },
          "404": {
            "description": "There is no such error code.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "not_found": {
                    "summary": "Not Found",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/not_found",
                      "title": "Not Found",
                      "status": 404,
                      "detail": "There is no API resource at /api/errors/unknown.",
                      "instance": "/api/errors/unknown",
                      "code": "not_found",
                      "hint": "The endpoints are listed at https://blogmate.ai/api and described in full at https://blogmate.ai/openapi.json.",
                      "ok": false,
                      "error": "There is no API resource at /api/errors/unknown."
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                },
                "examples": {
                  "internal_error": {
                    "summary": "Internal Server Error",
                    "value": {
                      "type": "https://blogmate.ai/api/errors/internal_error",
                      "title": "Internal Server Error",
                      "status": 500,
                      "detail": "Something failed on our side.",
                      "code": "internal_error",
                      "hint": "Retry in a minute. If it keeps failing, write to info@blogmate.ai.",
                      "ok": false,
                      "error": "Something failed on our side."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorCode": {
        "type": "string",
        "description": "A stable, machine-readable error code.",
        "enum": [
          "invalid_json",
          "invalid_email",
          "invalid_name",
          "invalid_subject",
          "invalid_message",
          "not_found",
          "post_not_found",
          "method_not_allowed",
          "not_configured",
          "storage_failed",
          "delivery_failed",
          "internal_error"
        ]
      },
      "Problem": {
        "type": "object",
        "description": "An RFC 9457 problem details object. `code` and `hint` are extension members; `ok` and `error` are kept for the site's own forms.",
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "code",
          "hint",
          "ok",
          "error"
        ],
        "properties": {
          "type": {
            "type": "string",
            "format": "uri",
            "description": "Identifies the problem type, and dereferences to its documentation (getErrorCode)."
          },
          "title": {
            "type": "string",
            "description": "A short summary of the problem type."
          },
          "status": {
            "type": "integer",
            "minimum": 400,
            "maximum": 599,
            "description": "The HTTP status code."
          },
          "detail": {
            "type": "string",
            "description": "What went wrong with this request, for a person to read."
          },
          "instance": {
            "type": "string",
            "description": "The path of the request the problem occurred on."
          },
          "code": {
            "$ref": "#/components/schemas/ErrorCode"
          },
          "hint": {
            "type": "string",
            "description": "How to fix the request, or what to do next."
          },
          "ok": {
            "type": "boolean",
            "const": false,
            "description": "Always false."
          },
          "error": {
            "type": "string",
            "description": "The same text as `detail`."
          }
        }
      },
      "ProblemType": {
        "type": "object",
        "description": "The documentation of one error code.",
        "required": [
          "type",
          "code",
          "status",
          "title",
          "hint"
        ],
        "properties": {
          "type": {
            "type": "string",
            "format": "uri",
            "description": "The URL error responses with this code carry as `type`."
          },
          "code": {
            "$ref": "#/components/schemas/ErrorCode"
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status the code comes with."
          },
          "title": {
            "type": "string",
            "description": "A short summary of the problem type."
          },
          "hint": {
            "type": "string",
            "description": "How to fix the request, or what to do next."
          }
        }
      },
      "ProblemTypeList": {
        "type": "object",
        "required": [
          "errors"
        ],
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProblemType"
            }
          }
        }
      },
      "ApiIndex": {
        "type": "object",
        "required": [
          "name",
          "version",
          "description",
          "status",
          "documentation",
          "endpoints"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "version": {
            "type": "string",
            "description": "The version of this API description."
          },
          "description": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pre-launch"
            ],
            "description": "Where the product stands. `pre-launch`: no accounts yet; the waitlist is the way in."
          },
          "documentation": {
            "type": "object",
            "required": [
              "openapi",
              "llms",
              "catalog",
              "errors",
              "docs"
            ],
            "properties": {
              "openapi": {
                "type": "string",
                "format": "uri",
                "description": "This OpenAPI document."
              },
              "llms": {
                "type": "string",
                "format": "uri",
                "description": "llms.txt, the site described for agents."
              },
              "catalog": {
                "type": "string",
                "format": "uri",
                "description": "The RFC 9727 API catalog."
              },
              "errors": {
                "type": "string",
                "format": "uri",
                "description": "The list of error codes."
              },
              "docs": {
                "type": "string",
                "format": "uri",
                "description": "The developer docs page."
              }
            }
          },
          "endpoints": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "operationId",
                "method",
                "path",
                "url",
                "summary"
              ],
              "properties": {
                "operationId": {
                  "type": "string"
                },
                "method": {
                  "type": "string",
                  "enum": [
                    "GET",
                    "POST"
                  ]
                },
                "path": {
                  "type": "string"
                },
                "url": {
                  "type": "string",
                  "format": "uri-template",
                  "description": "The absolute URL. Path parameters appear as `{name}` (RFC 6570)."
                },
                "summary": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "Pricing": {
        "type": "object",
        "description": "blogmate's pricing: one plan with everything in it, priced per workspace.",
        "required": [
          "currency",
          "vatIncluded",
          "availability",
          "waitlistUrl",
          "note",
          "plan",
          "agency",
          "invoicing"
        ],
        "properties": {
          "currency": {
            "type": "string",
            "description": "ISO 4217 currency code of every amount.",
            "examples": [
              "EUR"
            ]
          },
          "vatIncluded": {
            "type": "boolean",
            "description": "Whether amounts include VAT. They do not."
          },
          "availability": {
            "type": "string",
            "enum": [
              "waitlist"
            ],
            "description": "`waitlist`: blogmate is pre-launch, and a spot at this price is offered through the waitlist."
          },
          "waitlistUrl": {
            "type": "string",
            "format": "uri",
            "description": "Where a person joins the waitlist."
          },
          "note": {
            "type": "string",
            "description": "What the price means while the product is pre-launch."
          },
          "plan": {
            "type": "object",
            "required": [
              "id",
              "name",
              "tagline",
              "unit",
              "prices",
              "features"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Stable plan identifier."
              },
              "name": {
                "type": "string"
              },
              "tagline": {
                "type": "string"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "workspace"
                ],
                "description": "What one price buys: a workspace, which is one blog on one site."
              },
              "prices": {
                "type": "object",
                "required": [
                  "monthly",
                  "annual"
                ],
                "properties": {
                  "monthly": {
                    "$ref": "#/components/schemas/PlanPrice"
                  },
                  "annual": {
                    "$ref": "#/components/schemas/PlanPrice"
                  }
                }
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Everything the plan includes."
              }
            }
          },
          "agency": {
            "type": "object",
            "description": "For studios running a roster of client blogs: quoted, not listed.",
            "required": [
              "name",
              "tagline",
              "price",
              "priceNote",
              "features",
              "contactUrl"
            ],
            "properties": {
              "name": {
                "type": "string"
              },
              "tagline": {
                "type": "string"
              },
              "price": {
                "type": "string",
                "enum": [
                  "custom"
                ],
                "description": "Quoted per roster; ask through sendContactMessage."
              },
              "priceNote": {
                "type": "string"
              },
              "features": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "contactUrl": {
                "type": "string",
                "format": "uri"
              }
            }
          },
          "invoicing": {
            "type": "string",
            "description": "How invoices and payment work."
          }
        }
      },
      "PlanPrice": {
        "type": "object",
        "description": "One billing period's price, per workspace, excluding VAT.",
        "required": [
          "perMonth",
          "billedEvery",
          "billedAmount"
        ],
        "properties": {
          "perMonth": {
            "type": "number",
            "minimum": 0,
            "description": "The effective price per month."
          },
          "billedEvery": {
            "type": "string",
            "enum": [
              "month",
              "year"
            ],
            "description": "How often an invoice is sent."
          },
          "billedAmount": {
            "type": "number",
            "minimum": 0,
            "description": "The amount of each invoice."
          },
          "savingPercent": {
            "type": "integer",
            "minimum": 0,
            "maximum": 100,
            "description": "Whole-percent saving against paying monthly."
          }
        }
      },
      "ChangelogEntry": {
        "type": "object",
        "required": [
          "title",
          "date",
          "category",
          "summary",
          "details"
        ],
        "properties": {
          "title": {
            "type": "string"
          },
          "version": {
            "type": "string",
            "description": "Release tag, when the change has one.",
            "examples": [
              "v0.1"
            ]
          },
          "date": {
            "type": "string",
            "format": "date",
            "description": "When it shipped."
          },
          "category": {
            "type": "string",
            "enum": [
              "new",
              "improved",
              "fixed"
            ]
          },
          "summary": {
            "type": "string"
          },
          "details": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ChangelogList": {
        "type": "object",
        "required": [
          "entries"
        ],
        "properties": {
          "entries": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ChangelogEntry"
            },
            "description": "Newest first."
          }
        }
      },
      "Author": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string"
          },
          "role": {
            "type": "string"
          }
        }
      },
      "PostSummary": {
        "type": "object",
        "required": [
          "slug",
          "title",
          "publishedAt",
          "readingTimeMinutes",
          "url",
          "markdownUrl"
        ],
        "properties": {
          "slug": {
            "type": "string",
            "description": "Identifies the post; pass it to getBlogPost."
          },
          "title": {
            "type": "string"
          },
          "excerpt": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "how-to",
              "comparison",
              "guide",
              "use-case",
              "explainer",
              "listicle",
              "opinion",
              "product"
            ],
            "description": "The post's content format."
          },
          "typeLabel": {
            "type": "string",
            "description": "The content format as the site labels it."
          },
          "publishedAt": {
            "type": "string",
            "format": "date-time"
          },
          "readingTimeMinutes": {
            "type": "integer",
            "minimum": 1
          },
          "url": {
            "type": "string",
            "format": "uri",
            "description": "The post's page."
          },
          "markdownUrl": {
            "type": "string",
            "format": "uri",
            "description": "The post as Markdown."
          },
          "author": {
            "$ref": "#/components/schemas/Author"
          }
        }
      },
      "PostList": {
        "type": "object",
        "required": [
          "posts"
        ],
        "properties": {
          "posts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PostSummary"
            },
            "description": "Newest first."
          }
        }
      },
      "Post": {
        "description": "A published post with its full body.",
        "allOf": [
          {
            "$ref": "#/components/schemas/PostSummary"
          },
          {
            "type": "object",
            "required": [
              "updatedAt",
              "bodyMarkdown",
              "related"
            ],
            "properties": {
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "description": "When the post last changed."
              },
              "bodyMarkdown": {
                "type": "string",
                "description": "The full body, as Markdown."
              },
              "related": {
                "type": "array",
                "description": "Up to two other posts, newest first.",
                "items": {
                  "type": "object",
                  "required": [
                    "slug",
                    "title",
                    "url"
                  ],
                  "properties": {
                    "slug": {
                      "type": "string"
                    },
                    "title": {
                      "type": "string"
                    },
                    "url": {
                      "type": "string",
                      "format": "uri"
                    }
                  }
                }
              }
            }
          }
        ]
      },
      "WaitlistSignup": {
        "type": "object",
        "description": "Send only these fields: a request carrying any other field is treated as automated spam and answered with a success that stores nothing.",
        "additionalProperties": false,
        "required": [
          "email"
        ],
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "maxLength": 254,
            "description": "The address of the person joining, given by that person. blogmate emails it a confirmation link."
          },
          "source": {
            "type": "string",
            "pattern": "^[a-z0-9-]+$",
            "maxLength": 64,
            "description": "Where the signup came from, for attribution. Agents should send `agent`. A value that does not match is recorded as `waitlist-page`."
          }
        }
      },
      "WaitlistResult": {
        "type": "object",
        "required": [
          "ok",
          "status",
          "message"
        ],
        "properties": {
          "ok": {
            "type": "boolean",
            "const": true
          },
          "status": {
            "type": "string",
            "enum": [
              "created",
              "pending",
              "confirmed"
            ],
            "description": "`created` or `pending`: a confirmation link is on its way, or went out in the last few minutes; the address counts once its owner clicks it. `confirmed`: the address was already confirmed, and its place is unchanged."
          },
          "message": {
            "type": "string",
            "description": "What to tell the person, in the site's words."
          }
        }
      },
      "ContactMessage": {
        "type": "object",
        "description": "Send only these fields: a request carrying any other field is treated as automated spam and answered with a success that delivers nothing.",
        "additionalProperties": false,
        "required": [
          "name",
          "email",
          "subject",
          "message"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120,
            "description": "The name of the person writing."
          },
          "email": {
            "type": "string",
            "format": "email",
            "maxLength": 254,
            "description": "Where the reply should go: the address of the person the message is from."
          },
          "subject": {
            "type": "string",
            "minLength": 1,
            "maxLength": 160
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "maxLength": 4000
          }
        }
      },
      "ContactResult": {
        "type": "object",
        "required": [
          "ok",
          "message"
        ],
        "properties": {
          "ok": {
            "type": "boolean",
            "const": true
          },
          "message": {
            "type": "string",
            "description": "What to tell the person, in the site's words."
          }
        }
      }
    }
  }
}
