# Welcome to Appear Schema automation for API teams in Enterprise. Welcome to Appear, the realtime API intelligence layer explicitly crafted for development teams building AI-focused enterprises. With Appear, you can instantly transform your existing APIs into intelligent, self-describing infrastructure without SDKs—simply with a lightweight introspector agent that observes your API traffic and automatically generates comprehensive schemas, documentation, and AI-ready integrations. Our platform captures schemas from live traffic, creating a canonical source of truth that continuously evolves with your development workflow, powering everything from documentation to AI agent integrations.

Appear's API Catalog explorer experience makes exploring your services intuitive and contextual.

### What's Appear's vision? Appear exists to **build the realtime API intelligence layer that powers AI-focused enterprises**—transforming legacy APIs into intelligent infrastructure without rewrites. Every company racing toward AI hits the same bottleneck: APIs that can't communicate with intelligent systems. Traditional APIs are hand-maintained, poorly documented, and fundamentally incompatible with AI agents that expect self-describing, discoverable systems. Appear's vision is to **eliminate this transformation barrier** by creating a living, breathing intelligence layer that continuously observes, understands, and evolves your entire API ecosystem in real-time. #### **What We Stand For** * **APIs Should Be Self-Describing** – Your infrastructure should automatically generate schemas, documentation, and AI integrations without manual intervention. * **Schema Automation** – Real-time schema capture and evolution should be the foundation of API intelligence, not an afterthought. * **AI-Native Infrastructure** – Every API should be instantly discoverable and composable by AI agents, enabling seamless human-AI collaboration. * **Offline-First Development** – Teams should work seamlessly whether online, offline, or somewhere in between, with intelligent syncing that never breaks. #### **Where We're Headed** We're building the foundational nervous system for AI-driven companies. Appear aims to be the essential intelligence layer that every AI-focused enterprise relies on—quietly, powerfully, and permanently embedded in how companies build and operate software. We're creating a platform that not only **discovers APIs** but **makes them natively intelligent** through: * **Real-time schema automation** that captures and evolves API behavior continuously * **AI agent enablement** with automatic MCP generation, agent instructions, and context provisioning * **Intelligent conflict resolution** that prevents API breakage across distributed teams * **Programmable automations** for docs, changelogs, SDKs, and custom workflows * **Offline-first architecture** with seamless sync across development environments * **Integration ecosystem** that connects with best-in-class developer tooling Our mission is simple: **Make APIs intelligent infrastructure, so AI-focused teams can build the future without infrastructure bottlenecks.** *** ### Want a demo first? Contact us at , or book a time with us [here](https://cal.com/appear.sh/demo). We'd love to show you what we're doing and get your feedback. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # How Appear works Appear passively observes your private network traffic to generate documentation based off your production schema, plus much more. Appear's introspector snippet can be dropped into your services, in one or many locations. The introspector locally infers your actual schema without sending any actual content, PII, or sensitive data to our servers—only the structure is reported. {% hint style="success" %} **Appear does not report on any PII data**. The package only reports on the schema. This means that your sensitive data does not leave your network and is not seen by Appear. Privacy is baked into how we have architected our platform to remove this as a barrier for you to begin enjoying effortless API management. {% endhint %}

Appear's introspector reports on your services schema only, ensuring no sensitive data leaves your network.

{% hint style="info" %} Note: Appear's introspector will automatically generate your service endpoint documentation, OpenAPI specs, and sample data when endpoints are fired via interaction with your APIs. If known endpoints are not visible in Appear, you can manually add them by uploading the associated spec. {% endhint %} ### Benefits of Appear * **Realtime API Intelligence**: Appear automatically captures and evolves API schemas from live traffic (deterministic data), creating a living intelligence layer that continuously understands your entire API ecosystem. This real-time schema automation ensures your APIs stay current, documented, and AI-ready without manual intervention, eliminating the infrastructure bottleneck that blocks AI transformation. * **Zero-Friction Integration**: With Appear's lightweight introspector agent, teams can transform legacy APIs into intelligent, self-describing infrastructure without code changes, rewrites, or SDKs. This seamless integration lets developers focus on building AI-powered features while Appear handles the complex schema automation in the background. * **AI-Native Development Experience**: Appear creates the foundational intelligence layer that powers AI-focused enterprises, automatically generating MCPs, agent instructions, and AI-consumable formats from your existing APIs. Its offline-first architecture and programmable automations enable seamless human-AI collaboration, whether you're online, offline, or switching between environments, making your entire development workflow natively intelligent. ### Appear safely observes your traffic Appear's open-source introspector is entirely auditable and available for review [here](https://github.com/appear-sh/introspector-js). ### Your sensitive data is kept safe Appear's open-source introspector only sends back the structure of the API schema to the Appear app. This means that Appear never receives personally identifiable information (PII data). *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Who is Appear for? Appear solves a critical problem that exists in nearly every company around the world. However there are specific roles and people that we focus on when designing and building the platform. Appear is built for **engineering teams at AI-focused enterprises** who need their APIs to work seamlessly with intelligent systems—without the years-long retrofit projects most companies face. **The Core Problem** Every company is racing to deploy AI, but legacy APIs aren't ready. Traditional APIs are hand-maintained, poorly documented, and incompatible with AI agents that expect self-describing, discoverable systems. This creates a massive bottleneck for AI transformation. **Who Benefits from Appear?** **Engineering Teams Building AI Features** You need APIs that AI agents can discover and interact with automatically. * **Automatic MCP Generation** – Turn existing APIs into AI-agent-ready interfaces * **Real-time Schema Intelligence** – APIs that evolve and stay current automatically * **Offline-First Development** – Build AI features whether online or offline **Platform & Infrastructure Teams** You're responsible for making company APIs AI-ready at scale. * **Schema Automation** – Capture and evolve schemas from live traffic automatically * **Zero-Friction Integration** – Transform legacy APIs without rewrites * **Intelligent Conflict Resolution** – Prevent API breakage across distributed teams **Technical Leaders & Architects** You need to enable AI transformation without disrupting existing systems. * **API Intelligence Layer** – Comprehensive view of your entire API ecosystem * **Automated Compliance** – Ensure APIs meet AI-agent expectations * **Strategic Insights** – Understand which APIs are AI-ready and which need attention **If you're building AI-powered products** and your APIs are blocking progress, Appear transforms your existing infrastructure into the intelligent, self-describing systems that AI agents expect—while your team sleeps. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Get In Touch Whether it's feedback, requests for information, or bugs, we'd love to hear from you. ### General contact If you'd like to get in touch with us to talk APIs, see what we're about, or ensure we're real people, please [contact us](mailto:contact@appear.sh) or shoot us a note via our website here: [appear.sh/contact](https://www.appear.sh/contact) e: *** ### Service status If anything is down, you can be sure we're working on resolving this urgently. You can check the status of our services here: {% embed url="" %} ### Support Please [request support](mailto:support@appear.sh) if you'd like help with your Appear account or to request improvements or support for you and your team. This includes any issues you're having with Appear and its technologies. e: *** ### Open source Appear strives to open-source components used in its tooling that it believes would benefit the community. This is part of our open-source pledge and part of helping other makers, contributors, doers and thinkers around APIs in our collective mission to uplift the critical infrastructure of APIs globally.. If you'd like to know more about our open-source projects or how to contribute, reach out to us [here](mailto:open-source@appear.sh). e: *** ### Feedback We love feedback. If you have anything to say about what we're doing or how we're doing it, we would love to here from you! e: # Early Access Programme Learn about what it means to be part of Appear's Early Access Programme, and why it may be the right fit for your team. Appear is a SaaS platform designed to create hyper simplicity around your API lifecycle management, starting with discovering and documenting your APIs instantly. As we move through further feature development and folding in customer feedback, we're on the lookout for companies or teams who stand to gain benefit from Appear's current spread of capabilities and what's planned in the near term. Visit our [product map](https://www.appear.sh/product-map) to see if that's applicable for you. ### Key information * Early Access (pilot) is for a minimum of 1 month * It is free for the duration of the pilot * Appear and your team work closely to ensure a smooth introduction, with close communication channels and feedback loops * There is no obligation to continue with Appear at the end of the Early Access (pilot) period * You can terminate at any time * Should you wish to subscribe to Appear at the end of the Early Access (pilot) period, it will be discounted forever to honour your contribution to our journey To learn more and discuss it further, get in touch with us . # Installation See what languages, containers, and frameworks we support. Keep an eye on this list as it evolves based on customer feedback and releases. You can integrate with Appear in three key ways right now. 1. [SDKs](/installation/sdk-installations) 2. API endpoint (docs coming soon) 3. OTel integration (docs coming soon) For the majority of users, the SDK approach is the most expedient. Below gives an outline of how to install Appear's introspector agent SDK. *** ## SDK installation overview {% stepper %} {% step %} ### Create an Appear account [Contact us](/getting-started/get-in-touch), and we will provide you with an admin account. You can then add team members and configure your organisation. {% endstep %} {% step %} ### Get your API key Open the side menu and click on 'Settings' to create and view API keys. These can be used to separate concerns. Note that API keys aren't used per environment, as these are handled via the introspector detecting the environment variables. You may wish to store this as an environment variable. ``` APPEAR_API_KEY:your_api_key ``` {% endstep %} {% step %} ### Install the Appear package Choose the installation method and follow the instructions: * [Javascript/Typescript](/installation/sdk-installations/node-js-ts) * [NextJS](/installation/sdk-installations/nextjs) * [Redwood JS & Vercel](/installation/sdk-installations/redwood-js-and-vercel) Install the package to your system. Installation methods vary per implementation, but the below gives a general idea: ``` npm i @appear.sh/introspector ``` Is what you need not visible? [Get in touch](/getting-started/get-in-touch) with us and we'll see what we can do! {% endstep %} {% step %} ### Integrate Appear Once the package is installed, import it using your chosen language or framework method. Below gives a general idea: ```typescript import * as Appear from '@appear.sh/introspector' Appear.init({ apiKey: 'your-api-key', environment: process.env.NODE_ENV, }) ``` {% endstep %} {% endstepper %} ## What to expect Now that you've installed and integrated Appear, you can run your development server and mock user interactions through your application. As this happens, your Appear account will begin being populated with your API catalog, API references, resource maps, and more. Once Appear is in your production environment, your account will populate automatically when users interact with your product. This will instantly provide you with: * API references * API catalog * Visual resource map * Responses * Scenarios * Plus loads more *** ## Language/framework implementations status Appear's introspection agent currently works with HTTP/REST APIs with the following.
FrameworkSDK statusAPI Endpoint statusOTel integration status
NestJStruetruefalse
NextJStruetruefalse
Node.jstruetruefalse
Kotlinfalsetruefalse
PHPfalsetruefalse
.Netfalsetruefalse
Rubyfalsetruefalse
Gofalsetruefalse
Kubernetes Sidecarfalsefalsefalse
ECS Ssidecarfalsefalsefalse
Missing what you need to get started with Appear? [Request support](mailto:support@appear.sh) and we would love to discuss how we can help you. ## Unsupported At this stage, we don't have concrete plans to support the following: * GraphQL * gRPC * Async APIs *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # SDK installations Not all services are deployed as a node applications. If that applies to you, you can either use one of pre-built integrations, or write your own adapter. Our SDK coverage will grow over time, but if you're urgently needing coverage please [request support](mailto:support@appear.sh). We also support other methods to connect with Appear, like reporting to our [API endpoints](/installation/api-endpoint) and using an [OTel integration](/installation/open-telemetry-integration).
FrameworkSDK status
Node.jsReady
NestJSReady
NextJSReady
KotlinPlanned. Request support
PHPPlanned. Request support
.NetPlanned. Request support
RubyPlanned. Request support
GoPlanned. Request support
RustPlanned. Request support
We're working on supporting more frameworks to ensure Appear can enable as many engineering teams as possible. If you have any requests for our framework support, please [get in touch](/getting-started/get-in-touch) with us. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Node (JS/TS) Using our Javascript & Typescript introspector is simple: three steps and Appear gets to work. This JS introspector is a tool that listens to both incoming and outgoing traffic in JS runtime (browser, node) and detects the shape (schema) of it and reports this schema to Appear platform where it's further merged, processed, and analysed Because it reports only the schema of the traffic, it never sends any actual content of the data nor PII. The following installation guide covers Node server along with thin servers like Express, Fastify, Koa, etc. ## Installation steps {% stepper %} {% step %} ### Install the Appear package (select one) ```bash npm i @appear.sh/introspector // or yarn add @appear.sh/introspector // or pnpm add @appear.sh/introspector ``` {% endstep %} {% step %} ### Create a new JS file You can place the new `appear.js` file anywhere in your file structure. The specific method of how to do this may vary on your chosen framework. {% code title="appear.js" overflow="wrap" %} ```typescript import { registerAppear } from "@appear.sh/introspector/node" registerAppear({ apiKey: process.env.APPEAR_REPORTING_KEY, environment: process.env.NODE_ENV, serviceName: "User Service", // name of the service you're instrumenting (optional) }) ``` {% endcode %} {% endstep %} {% step %} ### Add Node hook Add the hook into Node by adding the --import parameter to the **start script**. This is usually in `package.json` . ```javascript node --import ./appear.js server.js ``` If your framework use some CLI wrapper around node you can also use env variable approach. ```sh NODE_OPTIONS='--import ./appear.js' node-wrapper start ``` {% endstep %} {% step %} ### Log into Appear to view entries The introspector will begin reporting the structure of your API services when they're interacted with. Log into [Appear](broken://spaces/k1FE7BkpojojQWs9RfaQ/pages/fgXrRYhHPH6UqaisimYD) with your credentials to view the services that appear. You may need to refresh the page periodically. {% endstep %} {% endstepper %} *** ## Configuration To configure how the introspector reports your schemas to Appear, you can adjust in the file below. {% code overflow="wrap" fullWidth="false" %} ```javascript Configuration To configure how the introspector reports your schemas to Appear, you can adjust in the file below. export interface AppearConfig { /** * API key used for reporting * you can obtain your reporting key in keys section in Appear settings * reporting keys have only the permission to report schema and can't read any data * you can use any method to inject the key, in examples we used env variable */ apiKey: string /** * Environment where the report is sent from * it can be any string that identifies environment data are reported from. * Often used as "production" or "staging", however if you're using some form of ephemeral environment feel free to use its identifier */ environment: string /** * Name of current service * used to improve accuracy of matching, useful when you're not using descriptive host names in incoming requests * for example if you're using directly IP addresses * * @optional * @default hostname if not provided the service name will be detected from hostname */ serviceName?: string /** * A flag you can use to disable introspector completely * useful if you don't want to report in certain environments * * @default true */ enabled?: boolean /** * Enable debug mode which will output detailed debug information to the console, * including all reported traffic, validation errors, and other diagnostic data. * Useful for troubleshooting and understanding what data is being sent to Appear. * * @default false */ debug?: boolean /** configuration of how often and where data are reported */ reporting?: { /** * endpoint reports are sent to, useful if you want to audit what data are reported * simple audit can be done by navigating to https://public.requestbin.com/r which will give you endpoint url you can paste here and see in the debugger all traffic * * @default https://api.appear.sh/v1/reports */ endpoint?: string } interception?: { /** * Optional function that allows to filter what request/response pair is getting analyzed and reported. * You can reuse default filter by importing it from `import { defaultInterceptFilter } from "@appear.sh/introspector" and using it inside the function` * * @default (req, req, config) => req.destination === "" && !request.url.includes(config.reporting.endpoint) */ filter?: ( request: Request, response: Response, config: ResolvedAppearConfig, ) => boolean } } ``` {% endcode %} *** We're actively working on improving how Appear works with NextJS. If you have any queries or require support with the above instructions, please [contact us](/getting-started/get-in-touch). # NestJS The below instructions will guide you through setting up your NestJS application and deploying it in two steps. Follow along to get your project up and running. ## Installation guide {% stepper %} {% step %} ### Install using your favourite package manager ```bash npm i @appear.sh/introspector // or yarn add @appear.sh/introspector // or pnpm add @appear.sh/introspector ``` {% endstep %} {% step %} ### Add import into your main.ts file Include registerAppear() directly in to your main.ts file. See [example](#example-installation). {% hint style="warning" %} Ensure this script is included prior the bootstrap function. {% endhint %} {% code title="main.ts" overflow="wrap" %} ```typescript import { registerAppear } from "@appear.sh/introspector/node" registerAppear({ apiKey: process.env.APPEAR_REPORTING_KEY, environment: process.env.NODE_ENV, serviceName: "User Service", // name of the service you're instrumenting (optional) }) ``` {% endcode %} {% endstep %} {% step %} ### Log into Appear to view entries The introspector will begin reporting the structure of your API services when they're interacted with. Log into [Appear](broken://spaces/k1FE7BkpojojQWs9RfaQ/pages/fgXrRYhHPH6UqaisimYD) with your credentials to view the services that appear. You may need to refresh the page periodically. {% endstep %} {% endstepper %} *** ## Example installation ```typescript import { NestFactory } from "@nestjs/core" import { AppModule } from "./app.module" import { registerAppear } from "@appear.sh/introspector/node" registerAppear({ apiKey: "test-key", environment: "test", reporting: { endpoint: process.env.COLLECTOR_URL }, }) async function bootstrap() { const app = await NestFactory.create(AppModule) const server = await app.listen(0) const port = server.address().port console.log(`Server started on port ${port}`) } bootstrap() ``` *** ## Configuration To configure how the introspector reports your schemas to Appear, you can adjust in the file below. {% code title="config.ts" overflow="wrap" fullWidth="false" %} ```javascript export interface AppearConfig { /** * API key used for reporting * you can obtain your reporting key in keys section in Appear settings * reporting keys have only the permission to report schema and can't read any data * you can use any method to inject the key, in examples we used env variable */ apiKey: string /** * Environment where the report is sent from * it can be any string that identifies environment data are reported from. * Often used as "production" or "staging", however if you're using some form of ephemeral environment feel free to use its identifier */ environment: string /** * Name of current service * used to improve accuracy of matching, useful when you're not using descriptive host names in incoming requests * for example if you're using directly IP addresses * * @optional * @default hostname if not provided the service name will be detected from hostname */ serviceName?: string /** * A flag you can use to disable introspector completely * useful if you don't want to report in certain environments * * @default true */ enabled?: boolean /** * Enable debug mode which will output detailed debug information to the console, * including all reported traffic, validation errors, and other diagnostic data. * Useful for troubleshooting and understanding what data is being sent to Appear. * * @default false */ debug?: boolean /** configuration of how often and where data are reported */ reporting?: { /** * endpoint reports are sent to, useful if you want to audit what data are reported * simple audit can be done by navigating to https://public.requestbin.com/r which will give you endpoint url you can paste here and see in the debugger all traffic * * @default https://api.appear.sh/v1/reports */ endpoint?: string } interception?: { /** * Optional function that allows to filter what request/response pair is getting analyzed and reported. * You can reuse default filter by importing it from `import { defaultInterceptFilter } from "@appear.sh/introspector" and using it inside the function` * * @default (req, req, config) => req.destination === "" && !request.url.includes(config.reporting.endpoint) */ filter?: ( request: Request, response: Response, config: ResolvedAppearConfig, ) => boolean } } ``` {% endcode %} *** If you have any queries or require support with the above instructions, please [contact us](/getting-started/get-in-touch). # NextJS Appear offers two methods to integrate with NextJS based on serverless or self-hosted use cases. ## Hosted on Vercel and other serverless platforms When Next.js is hosted on Vercel and other serverless platforms, it has a suboptimal way to instrument API routes, which prevents us to properly detect traffic. Even the [instrumentation.ts](https://nextjs.org/docs/app/api-reference/file-conventions/instrumentation) doesn't fully work with OpenTelemetry as expected. In these scenarios please follow [Custom Integration](/installation/sdk-installations/custom-integrations) guide to create a wrapper around API route handlers. *** ## Self-hosted as service If you're self-hosting NextJS you can use `next start` to get going. ### Installation guide {% stepper %} {% step %} ### Install using your favourite package manager ``` npm i @appear.sh/introspector // or yarn add @appear.sh/introspector // or pnpm add @appear.sh/introspector ``` {% endstep %} {% step %} ### Initialise Appear in your app startup Create the`instrumentation.ts` file with the following code: {% code title="instrumentation.ts" overflow="wrap" %} ```typescript export const register = async () => { if (process.env.NEXT_RUNTIME === "nodejs") { // notice import from /nextjs entrypoint which comes with extra defaults const { registerAppear } = await import("@appear.sh/introspector/nextjs") registerAppear({ apiKey: process.env.APPEAR_REPORTING_KEY, environment: process.env.NODE_ENV, serviceName: "User Service", }) } } ``` {% endcode %} {% hint style="success" %} Appear's NextJS SDK has a preconfigured filter to avoid NextJS noise - see blow. {% endhint %} The **Next.js preset** (`/nextjs` entrypoint) includes a built-in `defaultInterceptFilter`.\ By default, it ignores all `/_next/` routes and any non-JSON responses. If you need to extend or customise this filter, you can import and build on it: ```typescript import { defaultInterceptFilter } from "@appear.sh/introspector/nextjs" ``` {% endstep %} {% step %} ### Update your start script Update your start script and pass `NODE_OPTIONS` variable to register appear hook. {% hint style="success" %} This ensures the Appear agent is loaded first, which is best practice for instrumentation agents. {% endhint %} ```json "scripts": { "start": "NODE_OPTIONS='--import ./appear.js' next start" } ``` {% endstep %} {% step %} ### Log into Appear to view entries The introspector will begin reporting the structure of your API services when they're interacted with. Log into [Appear](broken://spaces/k1FE7BkpojojQWs9RfaQ/pages/fgXrRYhHPH6UqaisimYD) with your credentials to view the services that appear. You may need to refresh the page periodically. {% endstep %} {% endstepper %} *** ## Configuration To configure how the introspector reports your schemas to Appear, you can adjust in the file below. {% code title="config.ts" overflow="wrap" fullWidth="false" %} ```javascript export interface AppearConfig { /** * API key used for reporting * you can obtain your reporting key in keys section in Appear settings * reporting keys have only the permission to report schema and can't read any data * you can use any method to inject the key, in examples we used env variable */ apiKey: string /** * Environment where the report is sent from * it can be any string that identifies environment data are reported from. * Often used as "production" or "staging", however if you're using some form of ephemeral environment feel free to use its identifier */ environment: string /** * Name of current service * used to improve accuracy of matching, useful when you're not using descriptive host names in incoming requests * for example if you're using directly IP addresses * * @optional * @default hostname if not provided the service name will be detected from hostname */ serviceName?: string /** * A flag you can use to disable introspector completely * useful if you don't want to report in certain environments * * @default true */ enabled?: boolean /** * Enable debug mode which will output detailed debug information to the console, * including all reported traffic, validation errors, and other diagnostic data. * Useful for troubleshooting and understanding what data is being sent to Appear. * * @default false */ debug?: boolean /** configuration of how often and where data are reported */ reporting?: { /** * endpoint reports are sent to, useful if you want to audit what data are reported * simple audit can be done by navigating to https://public.requestbin.com/r which will give you endpoint url you can paste here and see in the debugger all traffic * * @default https://api.appear.sh/v1/reports */ endpoint?: string } interception?: { /** * Optional function that allows to filter what request/response pair is getting analyzed and reported. * You can reuse default filter by importing it from `import { defaultInterceptFilter } from "@appear.sh/introspector" and using it inside the function` * * @default (req, req, config) => req.destination === "" && !request.url.includes(config.reporting.endpoint) */ filter?: ( request: Request, response: Response, config: ResolvedAppearConfig, ) => boolean } } ``` {% endcode %} ## Example of custom interception filter In some situations it's desirable to filter out certain traffic from being reported to Appear. For example the service is redirecting unauthorized requests using 3XX status code which is normally considered as successful and it's creating noise. ```typescript import { registerAppear, defaultInterceptFilter, } from "@appear.sh/introspector/nextjs" registerAppear({ apiKey: process.env.APPEAR_REPORTING_KEY, environment: process.env.NODE_ENV, serviceName: "User Service", interception: { filter: (request, response, config) => { return ( defaultInterceptFilter(request, response, config) && !(response.status >= 300 && response.status < 400) // ignore redirects ) }, }, }) ``` *** We're actively working on improving how Appear works with NextJS. If you have any queries or require support with the above instructions, please [contact us](/getting-started/get-in-touch). # Custom integrations For some frameworks or situations (e.g., edge environments), automatic instrumentation isn't possible. However, you can still manually wrap your handlers to instrument them. In essence, there are three steps to implement custom integration: {% stepper %} {% step %} ### Normalise your request and response Get and normalize Request & Response objects - this heavily depends on your framework and runtime {% endstep %} {% step %} ### Process the operation Call `await process({ request, response, direction })` to process the request and response into an operation {% endstep %} {% step %} ### Report to Appear Call `report({ operations, config })` to report the processed operations to Appear {% endstep %} {% endstepper %} ### Example integration In the below example: * We wrap an Express-style request handler to add Appear reporting. * Since Express-style handlers typically use `res.json()` or `res.send()` to set the response body, we use a `Proxy` to intercept and capture the response content. * We normalize the `Request`, `Response`, and `Headers` objects so they work seamlessly with Appear's `process()` function. * We use Vercel’s `waitUntil()` to ensure the report is sent before the serverless function finishes, without delaying the response to the user. {% hint style="info" %} This example is intentionally verbose to highlight edge cases you may need to consider. In most cases, your integration will be much simpler. {% endhint %}
View example ```typescript import { process, report, AppearConfig } from "@appear.sh/introspector" import { waitUntil } from "@vercel/functions" import type { IncomingHttpHeaders, IncomingMessage, OutgoingHttpHeaders, ServerResponse, } from "node:http" type Handler = ( req: IncomingMessage & { query: Partial<{ [key: string]: string | string[] }> cookies: Partial<{ [key: string]: string }> body: any env: { [key: string]: string | undefined } }, res: ServerResponse & { send: any json: any status: any }, ) => void const normalizeHeaders = ( headers: IncomingHttpHeaders | OutgoingHttpHeaders, ) => { const entries = Object.entries(headers).reduce( (acc, [key, value]) => { if (typeof value === "string") acc.push([key, value]) if (typeof value === "number") acc.push([key, value.toString()]) if (Array.isArray(value)) value.forEach((v) => acc.push([key, v])) return acc }, [] as [string, string][], ) return new Headers(entries) } const normalizeRequest = (req: IncomingMessage & { body: any }) => { const protocol = req.headers["x-forwarded-proto"] || "http" const host = req.headers["x-forwarded-host"] || req.headers.host || "unknown" return new Request(new URL(req.url!, `${protocol}://${host}`), { method: req.method, headers: normalizeHeaders(req.headers), body: req.body || null, }) } const normalizeResponse = ( res: ServerResponse, body: object | string | Buffer | null | undefined, ) => { const responseHeaders = normalizeHeaders(res.getHeaders()) // 204 No Content, 304 Not Modified don't allow body https://nextjs.org/docs/messages/invalid-api-status-body if (res.statusCode === 204 || res.statusCode === 304) { body = null } // Response accepts only string or Buffer and next supports objects if (body && typeof body === "object" && !Buffer.isBuffer(body)) { body = JSON.stringify(body) } return new Response(body, { status: res.statusCode, statusText: res.statusMessage, headers: responseHeaders, }) } export function withAppear(handler: Handler, config: AppearConfig): Handler { return async (req, baseRes) => { // create a proxy to capture the response body // we need to do this because the syntax is res.json({ some: content }) let body: object | string | Buffer | null | undefined const res = new Proxy(baseRes, { get(target, prop, receiver) { if (prop === "json" || prop === "send") { return (content: any) => { body = content return Reflect.get(target, prop, receiver)(content) } } return Reflect.get(target, prop, receiver) }, }) const result = await handler(req, res) try { const request = normalizeRequest(req) const response = normalizeResponse(res, body) const operation = await process({ request, response, direction: "incoming", }) // report, don't await so we don't slow down response time waitUntil(report(operation, config)) } catch (e) { console.error("[Appear introspector] failed with error", e) } return result } } ```
*** If you have any queries or require support with the above instructions, please [contact us](/getting-started/get-in-touch). # Redwood JS & Vercel The below instructions will guide you through setting up your RedwoodJS application and deploying it seamlessly on Vercel. Follow along to get your project up and running. {% stepper %} {% step %} ### Install using your favourite package manager ```bash npm i @appear.sh/introspector // or yarn add @appear.sh/introspector // or pnpm add @appear.sh/introspector ``` {% endstep %} {% step %} ### Create instantiation file for Appear Create a file where you can instantiate Appear, for example: `api/src/withAppear.ts` ```typescript /// withAppear.ts import { createVercelMiddleware } from "@appear.sh/introspector/integrations/redwoodjs" export const withAppear = createVercelMiddleware({ // api key you can obtain at https://app.appear.sh/settings apiKey: "your-api-key", // any identifier of environment you prefer, we recommend separating production/staging/development. The more granular the better environment: process.env.NODE_ENV ?? "development", // other config as you desire // ... }) ``` {% endstep %} {% step %} ### Wrap your Serverless Functions Wrap your Serverless Functions (API Endpoints) in `withAppear` ```typescript // eg. api/src/functions//.ts import { withAppear } from "src/withAppear" export const handler = withAppear(async (event, context) => { // your code }) ``` {% endstep %} {% step %} ### Log into Appear to view entries The introspector will begin reporting the structure of your API services when they're interacted with. Log into [Appear](broken://spaces/k1FE7BkpojojQWs9RfaQ/pages/fgXrRYhHPH6UqaisimYD) with your credentials to view the services that appear. You may need to refresh the page periodically. {% endstep %} {% endstepper %} *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # API endpoint If we don't support your required language with our SDK, then you can write your own function to send traffic reports to our endpoint. This will serve as a DIY SDK. # Open Telemetry integration To integrate your system with Appear using the OTel SDK, simply configure the SDK by inserting your URL and token into the setup. This straightforward integration works across all programming languages. Please note that, while effective, the SDK does not currently support capturing request and response bodies. # Connections Once you've installed the SDK, connected to the API endpoint, or integrated with OTel, you can now connect your Appear account to your environments. ## Overview {% hint style="info" %} Precondition: you must have installed the Appear introspector agent SDK (or installed via other methods) first, before you can establish a connection successfully. {% endhint %} Connections represent the relationship between Appear's introspector agent and your service. Every time you deploy Appear's agent into your codebases, a connection will be created. ## Add a connection To create a connection, follow these steps: {% stepper %} {% step %} ### Log into your Appear account Visit and sign in to Appear with your credentials {% endstep %} {% step %} ### View the Connections page

The Connections view link is in the side navigation

Open the side menu to access the **Connections** page, or click **Add connection** when on an empty service. {% endstep %} {% step %} ### Add a new connection Click on the 'Add connection' button, which will open the connection creation guide.
{% endstep %} {% step %} ### Create or select an environment The first step is to create a new environment or select an existing one. If you have already installed and deployed the Appear introspector agent, there will be environment options to select from. If you're creating a new environment, type in the name and click **Create**, then click **Continue.**

The first step in the connection creation guide is to select or create your environment.

Read about branches and environments in our dedicated explainer page [here](/explanations/branches-and-environments). {% endstep %} {% step %} ### Choose a framework Browse the supported languages and frameworks for Appear's introspector agent and click on the one relevant for the codebase you're installing into.

Click or search through Appear's introspector agent's supported languages and frameworks.

Appear's [product-map](/resources/product-map) and [installation guides](/getting-started/installation) express what languages and frameworks supported both current and planned. {% endstep %} {% step %} ### Configure your installation: Naming your service Now you can configure your installation script with a **Service name** which helps the introspector understand the traffic and networking relationships.

Add a relevant service name to your installation. This will help better relate traffic to your service.

{% endstep %} {% step %} ### Scope your API key Give your API key a name, then scope it based on its use and expiry. Scope it by choosing between: * **Reporting only**, or * **Everything** Choose an expiry options: * **30 days** * **60 days** * **90 days, or** * **No expiration**

You can define your API scope's access and expiry.

Once you're comfortable with the settings, click **Save Settings**, and then **Continue**. {% endstep %} {% step %} ### Invite your team The next step is designed primarily for new user onboarding and provides a simple user experience for adding team members. This is skippable if not relevant for your use-case. {% endstep %} {% step %} ### Complete The connection is now created. You can now view the connections or dive into your **Catalog** to watch the services appear once the introspector agent is [installed](/getting-started/installation) and deployed or run locally. {% endstep %} {% endstepper %} ## View connections Once you've created a connection you can view them in the **Connections** view. This page lists out all your active and inactive connections, which are specific to your environment. ### Connection list The connections you create through the **Add connection** process or from installing Appear's introspector agent will appear automatically in the **Connections** view.

The connection list shows the state of your installed agents.

### Connections panel You can view each connection in your list to see some extra detail which can be useful for understanding if the Appear agent is reporting as expected.

Opening a connection shows connection metadata useful for debugging, in addition to a quick install guide reference.

*** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Importing an OpenAPI spec ## **OpenAPI Import Overview** When you upload an OpenAPI specification to Appear, the system parses and stores your spec in a structured domain model. The goal is to remain as close to the original spec as possible, while providing a consistent output format for downstream tooling. * **Storage:** Imported data is stored in its original shape. Nested objects are preserved without modification. * **Validation:** Appear attempts to recover from minor issues, but invalid specifications may fail to process. You can further validate your specification post import. * **Transactions:** Imports are transactional. If any step fails, no changes are saved. * **Output version:** Regardless of the uploaded version, Appear normalizes output to **OpenAPI 3.1**. *** ## **Schema to Domain Model Mapping** Below is a reference of how core OpenAPI objects are mapped inside Appear.
OpenAPI ObjectMapping in AppearNotes
Infotitle → service.name
summary → service.summary
description → service.description
termsOfService, contact, license, version → service.metadata		x-* extensions stored as metadata
ServersFully supported, including variables
Componentsschemas → resources
requestBodies → requests
pathItems → paths		links and callbacks not supported
PathsEach path creates a new path objectx-* extensions not supported
OperationsAll properties supportedcallbacks not supported
ParametersFully supported
Request BodyCreates request object with schema, examples, encodingsIf required: false, an alternate request with empty body is created
ResponsesEach response mapped to response object keyed by status codelinks not supported
HeadersFully supported
ExamplesFully supported
TagsInline tags are supported; tag metadata is not
ReferencesAlways embedded in parent
SchemasSaved as resource.schemaSupports discriminators, examples, and x-* extensions
*** ## **Unsupported Features** Currently not supported (will be ignored if present in your spec): * `links` (Response/Components/Link objects) * `callbacks` (Operation/Components/Callback objects) * `tag metadata` (only inline tags are preserved) * `x-*` extensions in `Paths` and some nested objects *** ## **Notes & Limitations** * Example values from `example` and `examples` are merged. * Encoding properties and custom `x-*` values are preserved as metadata where supported. * Future updates will expand support for currently unsupported objects. # OpenAPI spec version When Appear detects your API/service, it **automatically generates an OpenAPI v3.1 specification** and provides it as a link. This serves as a foundation for enhanced API documentation, tooling, and automation. ### **What Appear Does** * **Generates an OpenAPI v3.1 spec for your API/service** automatically. * **Provides a direct link** to the spec for easy access and integration. * **Lays the groundwork** for additional features that leverage OpenAPI for greater value. ### **Why This is Useful** * **Standardised API Definition** – Ensures your API has an available OAS structure for added flexibility within your existing tooling * **Instant Access to Documentation** – The OpenAPI spec can be used with Swagger UI, Redoc, and other tools. * **Easier API Consumption** – Enables automatic SDK generation, testing, and integrations. * **Future Expansion** – Appear will continue to build on this foundation to offer more insights and automation. The provides spec reflects the automatically generated descriptions and type definitions, that include any curated changes you make. ### Example: {% code overflow="wrap" %} ```bash { "openapi": "3.1.0", "info": { "title": "App API", "version": "test-api-routes" }, "servers": [ { "url": "http://localhost:3000/", "variables": { } } ], "tags": [], "paths": { "/app-api": { "summary": "App API data", "parameters": [], "post": { "tags": [], "summary": "Submit App Test", "description": "This endpoint accepts a JSON object with a single 'test' field, which must be a string of exactly 5 characters. It processes the input and returns a JSON object containing a 'hello' field, also a string of 5 characters. The service ensures strict adherence to the input and output length constraints.", "operationId": "/app-api#post", "parameters": [], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Test" } } } }, "responses": { "200": { "description": "", "headers": { "Content-Type": { "description": "The [MIME type](https://en.wikipedia.org/wiki/MIME_type) of this content", "schema": { "type": "string", "maxLength": 16, "minLength": 16 }, "example": "application/json" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Greet" } } } } } } } }, "components": { "schemas": { "Greet": { "type": "object", "required": [ "hello" ], "properties": { "hello": { "type": "string", "maxLength": 5, "minLength": 5 } } }, "Test": { "type": "object", "required": [ "test" ], "properties": { "test": { "type": "string", "maxLength": 5, "minLength": 5 } } } } } } ``` {% endcode %} ### **More to Come** The OpenAPI spec generator is one core concept for Appear. We are working on **leveraging this foundation** to provide deeper API insights, improved documentation, and streamlined workflows. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Branches and environments Learn about how branches and environments work in Appear. ### Overview The concepts of branches and environments in Appear help you effectively manage, track, and compare your API ecosystem versions across various development and deployment stages. This guide explains how these features work and how you can leverage them.

You can create new branches from the top level navigator. Environments are detected and set from you variable configuration.

### Shared aspects: Both Branches and Environments describe a version of your API model and generally contain the same type of information, however they differ in their meaning and behaviour.\ Branches and environments provide a layer over all services, allowing changes in one branch to impact multiple services, if applicable.
### Environments * Environments represent the current state of your deployment (e.g., `production`, `staging`, `test-farm-alpha`) * The version model is inferred from the environment using an introspector which ensures it reflects actual schema. * Unlimited Environments: You can create as many environments as needed. However, one environment will always be marked as the default, which is shown by default in the UI. * Diff Capabilities (planned): You will be able to compare (or "diff") environments with other environments or branches. This allows you to detect inconsistencies, breaking changes, or differences in implementation. ### Branches * Branches represent the intended changes in code and are created by users directly in Appear or by uploading a specification (manually, using CLI, or CI) * Branches can be forked from any environment or other branch * Branches can be merged to other branches by applying their diff * Branches can be linked to an environment. This automatically applies changes and helps detect inconsistencies. For example, this is useful for linking `main` branch with `production` environment ### Use Cases Deployment Safety: Use diffs between branches and environments to answer questions like “Can I deploy to production?” by detecting breaking changes before they occur. > Example: compare feature branch with production environment to validate the feature branch won't cause breaking change. API Consistency (planned): Use branches attached to environments to identify inconsistencies between API specifications and live implementations. > Example: link `main` branch with `production` and receive notification when service responds with data not matching contracts. Change Communication (planned): Use diffs to describe changes to your API and share automatically generated changelog to your consumers. > Example: automatically share API changes to your Slack channel so people know what's coming up *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Creating a service Appear will automatically document your APIs from your network traffic, however, if you wish to start spec first, or fill a gap with an existing spec then follow our simple guide below. ## Automatic discovery/creation Once you've deployed Appear's package and snippet into your environment(s), your end-user's interaction with your service and subsequent network activity will generate your documentation for you. These services will be created for you and be visible in your dashboard for you to explore and read.

When no services are detected or your branch/environment is empty, you are able to add a service manually.

If no services are found, either due to no package installation and integration or an empty branch or environment, you are able to manually upload OpenAPI specs. ## Creating a service manually Another method for Appear to document your APIs is to create a service and upload the associated `json` or `yaml` OpenAPI v3 - 3.1 or Swagger v2 file.

An empty service state with a guide on what information can be added.

To do this, log into your Appear account 1. On your dashboard page, click the **Create Service** button in the top right 2. In the presented panel, enter a **name** for the service 3. The **slug** will be automatically created, but can be edited, this will be used for the associated URL 4. Drag and drop, or use your system's file explorer to upload the associated API specification 5. Click **Create Service** and Appear will generate your documentation

When you add a new service you're able to upload an OpenAPI spec.

The spec upload facility allows you to upload multiple spec files associated to the one specification. It does not support the upload of multiple individual specs at once. {% hint style="info" %} You may need to refresh the page if the service doesn't appear in your service list after a successful upload. {% endhint %} *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Add service via URL Appear allows you to monitor a URL and ingest the service schema from it. In Appear, you can create a service by providing a **URL to an endpoint or API service**. This allows Appear to automatically **detect, ingest, and generate the API schema** using the introspector—without requiring an OpenAPI spec upload or network traffic detection. ### **How It Works** 1. **Create an Empty Service** – Start by defining a new service in Appear. 2. **Enter the Endpoint URL** – Provide the URL where the API is hosted (e.g., staging, development, production). 3. **Appear Introspects the API** – The introspector fetches the schema from the provided endpoint. 4. **Service is Generated** – Appear constructs the full service definition, just as if you had uploaded an OpenAPI spec.

This UI show's an empty service page with the 'Servers' field in focus. This is where you enter the URL of the service.

### **Why Use a URL Instead of an Upload?** * **Real-Time API Discovery** – Automatically generates an API schema from a live endpoint. * **No Manual OpenAPI Spec Needed** – If you don’t have an OpenAPI document, Appear builds one for you. * **Continuous Schema Updates** – Appear can re-ingest the schema when changes occur at the endpoint. ### **Supported URL Types** * **Direct API Endpoints** – URLs that return a structured API response. * **Service Root URLs** – Appear will attempt to infer the API structure if the service provides discoverable metadata. * **Environments & Branches** – Add multiple URLs to track different versions of your API. *** ## **Server URL with variables in Appear** The server URL supports variables when defining a service in Appear. You can use placeholders within the URL that can be dynamically replaced based on the environment, user input, or configuration settings. ### **How It Works** Instead of hardcoding a static URL, you can define parts of the URL as **variables** using curly braces `{}`. These variables can then be set dynamically when making API requests or generating documentation. For example: ```yaml servers: - url: https://{env}.api.example.com/v1 variables: env: default: staging enum: - dev - staging - production ``` ### **Why Use Variables?** 1. **Multi-Environment Support** – Easily switch between development, staging, and production without redefining the entire API structure. 2. **Flexible Configuration** – Define API behaviors based on different user settings or deployment contexts. 3. **Reusable Documentation** – OpenAPI specifications and generated docs remain adaptable for various environments. ### **How Appear Leverages This** * When adding a service, you can define variables within the server URL. * Appear will resolve these variables dynamically when interacting with the API. * Documentation and introspection will reflect the available environments or configurations. Using server variables makes your API setup more adaptable, ensuring **smooth transitions between environments** while keeping the documentation concise and maintainable. *** ### **Next Steps** * **Modify or Extend the Generated Schema** – After the service is generated, you can refine the service definition within the Catalog view Adding a service from a URL is a fast, automated way to bring your API into Appear, providing instant documentation and visibility without additional setup. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Grouping & filtering Once you have installed the Appear agent and it is connected (reporting) you will see your instance of the Appear platform begin to instantly populate with your services, resources, and references. You may wish to organise your services to be more meaningfully arranged based on your role, their association to a project, a team, or anything in between. This can be done with grouping and filtering. ## Grouping services ### Overview Organising services is handled with tags. This allows greater flexibility for all personas using your APIs. The only prerequisite to using tags is that you have a service present in your Catalog view. Tags are a free-form way to add extra dimensions to your services. These are added from the services detail column; accessed by clicking on an individual service in the Catalog view.

Image showing the menu open after typing # (hash/pound) to insert a new tag or select an existing one.

### Grouping your services Now that you have one (or many tags) in your Appear account, you can begin grouping services present in your service list by one or many tags. {% stepper %} {% step %} ### Open the grouping menu Click on the grouping icon in the left most column, next to the filter icon.

The grouping icon is next to the filter icon, at the top of the service list column

{% endstep %} {% step %} ### Select Tags Select 'Tags' from the menu, which then allows your to select one or many tags, which will the group your services accordingly. You can search for specific tags, or you can use glob patterns to cover many similar tags.

The grouping menu provides two options: connection status and tags

{% hint style="info" %} Note: Tags are flexible, so one service may exist in many tag groups. This may result in some of your services appearing several times in the service list, which is by design. {% endhint %} {% endstep %} {% step %} ### Group by connection status A further dimension to your grouping can be via the connection status. This is useful in the early stages of the integrating Appear agent and any debugging required. {% endstep %} {% endstepper %} ### Ungrouping your services Grouping services is limited to your account, and is designed to be a flexible and fluid way to arrange what you care about in the moment. It is simple to ungroup your services, which doesn't delete any of the underlying relationships (handled via tags). #### Ungrouping options * Click on the '**x**' next to the grouping tag visible on the services list column * Click on the selected tags in the grouping menu, this will deslect them * Click on **Deselect All** within the grouping menu in the **Tags** submenu ### Grouping behaviours The grouping functionality has some basic behaviours which are nice to be aware of as you navigate the Appear platform. 1. Selecting or deselecting groups persists across different environments or branches 2. A single service can be assigned to multiple tags, and therefore multiple groups, which means it will be present in those groups 3. Selecting a services present in multiple groups will show it selected multiple times in the service list view ### Grouping FAQs
Are my services groups seen by my team? No, your service groupings are only visible to you, which means you can play around and customise your grouping based on your specific needs.
How are service groups established? Grouping services is handled via tags. Once you've added a tag to a service (or many services) you can choose the tags in the grouping menu.
*** ## Filtering services Next to the grouping button icon there is the filter button icon. Clicking this will open a similar menu to the grouping menu, however offers another layer of how to arrange what is relevant to you in the moment.
Filtering works independently or in combination with grouping, allowing you to fine-tune your view. You can filter services by: * **Tags** * **Connection status** (Active, Stale, Lost, Waiting to connect, No Connection) This makes it easy to focus on a subset of services — whether you’re troubleshooting, reviewing deployments, or exploring a specific part of your system. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Editing your APIs Learn about how to curate your services in Appear's Catalog editor The block editor offers an intuitive interface for managing your API catalog effectively when maintaining API documentation in Appear. This guide will walk you through editing service, endpoint names, descriptions, and other modifiable elements. ### **Editing service or endpoint names** 1. **Service and Endpoint Names:** * To edit names or descriptions, simply click on the text you wish to change and enter an appropriate name * Your changes are auto-saved and will be reflected in all locations referencing the service or endpoint ### **Editing service, endpoint, and response descriptions** Appear gives you a strong starting point to further curate your services by generating descriptions of your services, endpoints, and responses.

Appear's block editor is visible when you click in an editable area, like the 'description' space at the top of the column.

There are some key areas you can edit within the Catalog. There are visible when you click into the description area at the top of your service, endpoint, or response columns. ### **Working with Tags, Owners, and Servers** 1. **Tags:** * Tags are free-text elements that can be added to categorize or label your services and endpoints. To add a tag: * invoke the block editor menu by entering `/` * Select 'Tags' from the menu * Enter '#' and then the name of the tag * Press enter * Tags help filter and search the catalog, making managing and navigating extensive API collections easier. Learn more about tagging and its concepts [here](/managing-your-apis/tagging-services).

Invoking the block editor menu is done via typing the forward-slash key '/'

1. **Owners:** * Owners can be assigned to each service or endpoint. These are the members of your team who own and are responsible for the service. * If the owner already exists in the organisation’s account list, you can select them from a dropdown menu. If not, you can create a new 'owner' (user) by typing their name and selecting the option to add. 2. **Servers:**
* Servers associated with each service or endpoint are detected automatically. However, if needed, you can manually insert additional server details to ensure that all potential runtime environments are covered. * Multiple servers may be detected and added to your server list, however you can manually add servers to a single Server block list * To edit or add server information, press `/` (forward slash) to invoke the block editor menu and choose the 'Servers' item. Enter in the server URL and Appear will begin checking that URL for reports from the package. **Inserting and Formatting Content** * To add new content blocks such as bullet lists, numbered lists, or code blocks, click the `/` button within the Catalog description areas. Just select the appropriate content type from the menu and place it where needed in your document. * For structured content like tables or to insert columns, use the respective options from the insert menu to enhance the layout and presentation of complex data. **Important Tips** * Not all sections in the Appear documentation are editable. Pay attention to the interface cues, as some fields may be locked based on the configuration settings or user permissions. * The editor will automatically save changes as you curate your services and endpoints *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Overriding/updating a service Appear will (soon) offer automatic diffs when it comes to API versions and changes seen in your network traffic, however you can import a spec if required. ### Automatic updates (soon) Appear passively watches your network traffic to generate your documentation, and uses that mechanism to detect deltas from your documentation and current network traffic. This will provide you with a simple interface to accept or deny detected changes, and create a changelog entry for your team to stay up to date with all service changes that occur. ### Import spec with a service Appear supports manually uploading a spec within an existing service, which will override the existing schema and documentation.

You can override an existing service by uploading an OpenAPI spec from the menu in the top-right of the service

1. Click into the service you wish to modify from your service list 2. Click **import** in the top right corner of the interface 3. Drag and drop, or use your system's file explorer to upload the associated API specification 4. Click **import OpenAPI** and Appear will generate an updated service based off your uploaded spec {% hint style="info" %} You may need to refresh the page if the service doesn't appear in your service list after a successful upload. {% endhint %} *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Tagging services ### Tagging overview Tagging services in Appear is a flexible and useful way to represent relationships across your systems, teams, and organisational structure. Tags are added directly from the **Service Details view** in the **Catalog**. You can apply them however you see fit — whether to represent environments, teams, business domains, or deployment regions. ### Tagging a service To tag a service, navigate to a service detail view and enter a new line in the editable section at the top half of the column. From there, invoke the block editor by typing '/' (forward-slash) and select **Tags**. Begin typing your tag, or select an existing one. You can add as many or as few as you like.
Use tags to organise, navigate, and assess your API ecosystem in a way that aligns with how your team or organisation works. ### Tagging concepts Tags in Appear are **not standalone objects** in the database — they only exist **in relation to services**. This means the list of available tags is simply an aggregate of all tags used across all services. When **adding a tag to a service**, we show tags from all environments and versions to encourage consistency and reuse across your system. However, when **grouping or filtering by tags**, we scope them to the current branch or environment. This ensures the results are relevant to the specific context you're viewing — like filtering only by tags used in your staging environment ### Tagging FAQs
Can my team see my tags? Yes, tags are shared across your team and organisation.
Can I delete or edit my tags? No, there is no central way to delete or manage tags once created. This facility is coming soon. If you need help with this, please [get in touch](/getting-started/get-in-touch).
*** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Managing team members Appear is designed to create clarity and unblock engineers to keep them in flow. Appear is more impactful the more of your team or organisation are involved. ### Getting started Once you've created your account (or had it provisioned via our team), you can add more of your team via the Appear interface. This page will show you how to complete the following steps: * Invite a new team member to your organisation * Accepting an invitation as a new user * Managing team access ### Inviting team members to your organisation Adding new members to your organisation from within Appear only requires a few steps. 1. First, log into Appear. Once complete, click on the menu icon in the top left of the screen 2. Then click on your company name (organisation name) at the bottom of the menu 3. This will open a small menu, click on "**manage organisation**" 4. In the new panel that opens, click on the middle "**invitations**" tab 5. Click on the "**invite**" button 6. In the next screen, add the work email addresses of your teammates with whom you wish to share a specific role, which can be selected in the "**Role**" dropdown 7. Click on the "**Send invitations**" button, and the invite is sent 8. Click on "**Finish**", you can now close the Members panel and continue with using Appear ### Accepting invitations as a new user When you've sent an invite, your new team members will get an email asking them to accept it. Once they click "**Accept invitation**", the user will be taken to a webpage to add personal information to be provided access: * First name * Last name * Email (confirmation) * Password Clicking on "**Continue**" will create the account and take the user to the organisation's dashboard. ### Managing team access As an Admin for your organisation, you will be able to add, remove, and modify how your team members access Appear. #### Modifying a team member's role You can see all your team members and change their role from within the Appear platform. 1. When logged in to Appear, click on your organisation's name in the menu. 2. Then click on "**Manage organisation**" 3. In the open panel, you can change each member's role. Once you make the selection, the change is made The current roles supported are "**Member**" and "**Admin**". #### Remove a team member By completing steps 1 and 2 above, you can then click on the three elipses at the end of the team member's row you wish to remove. It will open a panel with "**Remove member**". Clicking on this will remove the person and account from your organisation, however they will still have an account with Appear. ### Requests Team members from your organisation who register using [verified email domains](/managing-your-organisation/adding-verified-domains) can be either automatically enrolled in your organisation or require manual approval by an admin. Learn more about how Appear handles team members joining your organisation [here](/managing-your-organisation/adding-verified-domains). *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Adding verified domains You can add verified domains to allow users to join your organisation automatically if their email domain matches. ### Getting started Once you've created your account (or had it provisioned via our team), you can make it easy for your team to join by ensuring they are all automatically associated with your organisation when they sign up. 1. First, log into Appear. Once complete, click on the menu icon in the top left of the screen 2. Then click on your company name (organisation name) at the bottom of the menu 3. This will open a small menu, click on "**manage organisation**" 4. Click on "**Settings**" in the left menu of the panel to open the settings page 5. Click on "**Add domain**" under the verified domains section 6. Enter in the domain you wish to associate with the organisation 7. Click "**Continue**" to proceed 8. Once your domain is verified, you can specify the enrollment options: * **No automatic enrollments**: Users can only be invited to the organisation manually * **Automatic invitations**: Users are automatically invited to join the organisation when they sign up, and can join anytime * **Automatic suggestions**: Users receive a suggestion to request to join, but must be approved by an admin before they can join the organisation 9. Make the appropriate selection and click "**Continue**" ### Requests Your team members can register with Appear to gain access to your organisation; however, the process of how access is provided will depend on your "**Enrollment**" option. For this section, it is important to state that requests to join your organisation are listed in the "**Requests**" tab in the "**Manage organisation**" panel. The requests will require manual intervention to be approved or denied. This is a required step if you choose "**Automatic suggestions**" as an enrollment option. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # MCP docs Appear's MCP allows you to seamlessly consume the services Appear has automatically detected, plus any services you have manually [imported](/explanations/importing-an-openapi-spec) from your preferred IDE with agent support (ADE). You and your AI agents can now build with confidence safe in the knowledge that your agents are referencing deterministic, enriched, and real APIs, using the following tools: * **Query our docs** * **List your organisations** * **List all your branches and environments** (versions) * **Create a branch or environment** (version) within Appear from your IDE * List **all services** from within Appear * Get **service details** We will be expanding this list over time with customer feedback. If you wish to see a specific MCP tool avialable to improve your collaboration with AI agents, please reach out with your request. *** ## Requirements To connect and make use of Appear's MCP, the following requirements need to be met * An Appear account * Services available in your API Catalog * Agentic IDE, otherwise known as an MCP Client Application (Cursor, Windsurf, RooCode, Cline, Continue, Zed, Claude Desktop) *** ## Overview
Appear is an API Schema Automation Platform, and a core automation is allowing agents to interoperate with the enriched API data within your organisation's account in Appear. Following the above automation map, we can break down the data flow as follow: {% stepper %} {% step %} ### Report on API schemas from network traffic Schema data is continuously observed and reported by the traffic analyser. {% endstep %} {% step %} ### Import existing OpenAPI specs Fill gaps by uploading specs from GitHub CI or manually, enriching your catalog. {% endstep %} {% step %} ### Build your realtime API Catalog A unified catalog holds all discovered and imported schemas, powering downstream processes. {% endstep %} {% step %} ### Connect to your agentic IDE Your IDE integrates with Appear, accessing the catalog through a scoped MCP endpoint. {% endstep %} {% step %} ### Enable agentic workflows with MCP Agents query and act on APIs via Appear’s MCP, closing the loop between developer and agent. {% endstep %} {% endstepper %} This create a loop to help solve stagnant, incomplete, or missing API documentation from hindering consuming developer's workflow. We've written an [article](https://www.appear.sh/blog/why-your-api-docs-break-for-ai-agents) to explain why enriching your docs with Appear is critical for agent workflows. *** ## Installation Follow these steps to install the Appear MCP into your chosen agentic IDE (ADE). {% stepper %} {% step %} ### Add Appear to MCP Server list Copy the below code and add to your MCP JSON file inside your agentic IDE. ```json "appear": { "url": "https://api.appear.sh/mcp" } ``` {% endstep %} {% step %} ### Provide MCP access 1. In your MCP list, click on the '**login**' text to trigger the authentication flow. 2. Your agentic IDE (ADE) may prompt you to **open an external website**. Proceed and open the URL requested. 3. Allow access for your agentic IDE to access your **email address** and **basic profile information**. This will create the connection between Cursor and your Appear organisation. 4. Permit '**cursor-retrieval**' extension to open the stated URI, by clicking '**Open**' {% endstep %} {% step %} ### Check Appear MCP is connected Verify your Appear MCP is connected by viewing your MCP list. It should also list all available tools from the list [below](#appear-mcp-tools).
{% endstep %} {% endstepper %} You should now have your Appear organisation connected to your agentic IDE via Appear's MCP. If you encounter any issues or are unclear on these steps, please [get in touch](/getting-started/get-in-touch) with us. *** ## Appear MCP tools The following is a list of the current MCP tools we provide you and your agents for interoperating with your data within your Appear organisation account. ### Docs You can interact with the Docs tool to learn more about using Appear. This tool refers to this doc site and is automatically updated with any changes we make. Examples: * "How do I filter out NextJS noise?" * "What are the available configurations for the Appear file?" ### List orgs This tool lists the organisations associated to your account. This is required to help you in scoping the context relevant to your current tasks. {% hint style="info" %} Not relevant for users with only a single organisation. {% endhint %} ### List versions You can list the versions ([branches & environments](/explanations/branches-and-environments)) to assist with you and your agent selecting the appropriate branch or environment relevant to the current task. ### Create version This tool facilitates the ability to create a new environment or branch in your organisation. ### List services A core tool to list all services available within your Appear organisation. This request can be scoped to an organiation and version. ### Get service details This tool will get the full OpenAPI specification of a service, so the agent can provide any level of detail to you and other agents in the toolchain. *** ## Agentic IDE MCP resources For further information specific to your agentic IDE, please consult their MCP docs. * [Cursor](https://docs.cursor.com/context/model-context-protocol) * [Windsurf](https://docs.codeium.com/windsurf/mcp) * [Zed](https://zed.dev/docs/assistant/model-context-protocol) * [RooCode](https://docs.roocode.com/advanced-usage/mcp/) * [Cline](https://github.com/cline/cline?tab=readme-ov-file#add-a-tool-that) * [Claude Desktop](https://modelcontextprotocol.io/quickstart/user) * [LibreChat](https://www.librechat.ai/docs/configuration/librechat_yaml/object_structure/mcp_servers) *** ## Troubleshooting Sometimes the setup or connection process can get fiddly, but we're here to help! We want to ensure you're getting the most out of Appear's MCP to unlock your agentic workflows. Some basic checks to run through: 1. Check the MCP is installed and connected 2. Make sure you've authorised Appear's MCP server by clicking on the 'login' text under the MCP title 3. Visit your IDE's docs (listed above) for their MCP install process If these checks don't unblock you then refer to your IDE's MCP debugging controls to obtain logs. Copy and paste the logs and send to us at [@AppearAPI](https://x.com/AppearAPI) on X or via email at and we'll get back to you as soon as possible. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Services ## List Services > List all Services items.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/services":{"get":{"summary":"List Services","description":"List all Services items.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"list-services","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Services","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Services collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Service > Create a new Service item.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/services":{"post":{"summary":"Create Service","description":"Create a new Service item.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"create-service","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Service item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"responses":{"201":{"description":"Service created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Service > Get a Service item by its id.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/services/{id}":{"get":{"summary":"Get Service","description":"Get a Service item by its id.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"get-service-by-id","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Service identifier"},"required":true,"description":"Service identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Service details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Service > Completely replaces a Service item by its id.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/services/{id}":{"post":{"summary":"Replace Service","description":"Completely replaces a Service item by its id.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"replace-service-by-id","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Service identifier"},"required":true,"description":"Service identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Service item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"responses":{"200":{"description":"Service replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"201":{"description":"Service created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Service > Delete a Service item by its id.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/services/{id}":{"delete":{"summary":"Delete Service","description":"Delete a Service item by its id.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"delete-service-by-id","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Service identifier"},"required":true,"description":"Service identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Service deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Service > Partially updates a Service item by its id.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/services/{id}":{"patch":{"summary":"Update Service","description":"Partially updates a Service item by its id.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"update-service-by-id","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Service identifier"},"required":true,"description":"Service identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Service item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2qbbiirfegu","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}}}}}},"responses":{"200":{"description":"Service updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Services > List all Services items.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services":{"get":{"summary":"List Services","description":"List all Services items.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"list-services1","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Services","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Services collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Service > Create a new Service item.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services":{"post":{"summary":"Create Service","description":"Create a new Service item.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"create-service1","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Service item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"responses":{"201":{"description":"Service created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Service > Get a Service item by its id.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{id}":{"get":{"summary":"Get Service","description":"Get a Service item by its id.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"get-service-by-id1","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Service identifier"},"required":true,"description":"Service identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Service details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Service > Completely replaces a Service item by its id.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{id}":{"post":{"summary":"Replace Service","description":"Completely replaces a Service item by its id.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"replace-service-by-id1","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Service identifier"},"required":true,"description":"Service identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Service item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"responses":{"200":{"description":"Service replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"201":{"description":"Service created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Service > Delete a Service item by its id.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{id}":{"delete":{"summary":"Delete Service","description":"Delete a Service item by its id.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"delete-service-by-id1","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Service identifier"},"required":true,"description":"Service identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Service deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Service > Partially updates a Service item by its id.\ > \ > Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{id}":{"patch":{"summary":"Update Service","description":"Partially updates a Service item by its id.\n\nService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.","operationId":"update-service-by-id1","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Service identifier"},"required":true,"description":"Service identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Service item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2rdueqb4kz4","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}}}}}},"responses":{"200":{"description":"Service updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Service"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get service OpenAPI spec > Returns the machine-readable OpenAPI specification for a service. Supported versions: v3\_1 (JSON only). ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/services/{idOrSlug}/openapi/{filename}":{"get":{"summary":"Get service OpenAPI spec","description":"Returns the machine-readable OpenAPI specification for a service. Supported versions: v3_1 (JSON only).","operationId":"get-service-openapi","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":1,"description":"Service ID or slug"},"required":true,"description":"Service ID or slug","in":"path","name":"idOrSlug"},{"schema":{"type":"string","enum":["v3_1.json"],"description":"OpenAPI spec filename (e.g. v3_1.json)"},"required":true,"description":"OpenAPI spec filename (e.g. v3_1.json)","in":"path","name":"filename"}],"responses":{"200":{"description":"OpenAPI specification (JSON)","content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace or create service from OpenAPI spec > Accepts an OpenAPI specification in the request body. If the service exists (by id or slug), replaces its definition (paths, operations, servers, etc.) with the spec. If not found, creates a new service using idOrSlug as the slug. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/services/{idOrSlug}/openapi":{"post":{"summary":"Replace or create service from OpenAPI spec","description":"Accepts an OpenAPI specification in the request body. If the service exists (by id or slug), replaces its definition (paths, operations, servers, etc.) with the spec. If not found, creates a new service using idOrSlug as the slug.","operationId":"post-service-openapi","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":1,"description":"Service ID or slug"},"required":true,"description":"Service ID or slug","in":"path","name":"idOrSlug"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"openapi":{"type":"string"},"info":{"type":"object","additionalProperties":{}}},"required":["openapi","info"],"additionalProperties":{}}}}},"responses":{"200":{"description":"Service updated from OpenAPI spec","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]}},"required":["ok"]}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get service OpenAPI spec > Returns the machine-readable OpenAPI specification for a service. Supported versions: v3\_1 (JSON only). ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{idOrSlug}/openapi/{filename}":{"get":{"summary":"Get service OpenAPI spec","description":"Returns the machine-readable OpenAPI specification for a service. Supported versions: v3_1 (JSON only).","operationId":"get-service-openapi","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":1,"description":"Service ID or slug"},"required":true,"description":"Service ID or slug","in":"path","name":"idOrSlug"},{"schema":{"type":"string","enum":["v3_1.json"],"description":"OpenAPI spec filename (e.g. v3_1.json)"},"required":true,"description":"OpenAPI spec filename (e.g. v3_1.json)","in":"path","name":"filename"}],"responses":{"200":{"description":"OpenAPI specification (JSON)","content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace or create service from OpenAPI spec > Accepts an OpenAPI specification in the request body. If the service exists (by id or slug), replaces its definition (paths, operations, servers, etc.) with the spec. If not found, creates a new service using idOrSlug as the slug. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Services"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorService":{"description":"Service not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{idOrSlug}/openapi":{"post":{"summary":"Replace or create service from OpenAPI spec","description":"Accepts an OpenAPI specification in the request body. If the service exists (by id or slug), replaces its definition (paths, operations, servers, etc.) with the spec. If not found, creates a new service using idOrSlug as the slug.","operationId":"post-service-openapi","tags":["Services"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":1,"description":"Service ID or slug"},"required":true,"description":"Service ID or slug","in":"path","name":"idOrSlug"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"openapi":{"type":"string"},"info":{"type":"object","additionalProperties":{}}},"required":["openapi","info"],"additionalProperties":{}}}}},"responses":{"200":{"description":"Service updated from OpenAPI spec","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","enum":[true]}},"required":["ok"]}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"404":{"$ref":"#/components/responses/NotFoundErrorService"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Resources ## List Resources > List all Resources items.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources":{"get":{"summary":"List Resources","description":"List all Resources items.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"list-resources","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Resources","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Resources collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Resource > Create a new Resource item.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources":{"post":{"summary":"Create Resource","description":"Create a new Resource item.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"create-resource","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Resource item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"responses":{"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Resource > Get a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources/{id}":{"get":{"summary":"Get Resource","description":"Get a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"get-resource-by-id","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Resource details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Resource > Completely replaces a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources/{id}":{"post":{"summary":"Replace Resource","description":"Completely replaces a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"replace-resource-by-id","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Resource item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"responses":{"200":{"description":"Resource replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Resource > Delete a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources/{id}":{"delete":{"summary":"Delete Resource","description":"Delete a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"delete-resource-by-id","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Resource deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Resource > Partially updates a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources/{id}":{"patch":{"summary":"Update Resource","description":"Partially updates a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"update-resource-by-id","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Resource item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2tj5p4s3pdu","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Resources > List all Resources items.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources":{"get":{"summary":"List Resources","description":"List all Resources items.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"list-resources1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Resources","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Resources collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Resource > Create a new Resource item.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources":{"post":{"summary":"Create Resource","description":"Create a new Resource item.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"create-resource1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Resource item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"responses":{"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Resource > Get a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources/{id}":{"get":{"summary":"Get Resource","description":"Get a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"get-resource-by-id1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Resource details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Resource > Completely replaces a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources/{id}":{"post":{"summary":"Replace Resource","description":"Completely replaces a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"replace-resource-by-id1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Resource item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"responses":{"200":{"description":"Resource replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Resource > Delete a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources/{id}":{"delete":{"summary":"Delete Resource","description":"Delete a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"delete-resource-by-id1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Resource deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Resource > Partially updates a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources/{id}":{"patch":{"summary":"Update Resource","description":"Partially updates a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"update-resource-by-id1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Resource item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2ubt6cywtb4","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Paths ## List Paths > List all Paths items.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/paths":{"get":{"summary":"List Paths","description":"List all Paths items.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"list-paths","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Paths","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Path"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Paths collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Path > Create a new Path item.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/paths":{"post":{"summary":"Create Path","description":"Create a new Path item.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"create-path","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Path item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"responses":{"201":{"description":"Path created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Path > Get a Path item by its id.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorPath":{"description":"Path not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/paths/{id}":{"get":{"summary":"Get Path","description":"Get a Path item by its id.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"get-path-by-id","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Path identifier"},"required":true,"description":"Path identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Path details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorPath"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Path > Completely replaces a Path item by its id.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorPath":{"description":"Path not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/paths/{id}":{"post":{"summary":"Replace Path","description":"Completely replaces a Path item by its id.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"replace-path-by-id","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Path identifier"},"required":true,"description":"Path identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Path item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"responses":{"200":{"description":"Path replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"201":{"description":"Path created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorPath"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Path > Delete a Path item by its id.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorPath":{"description":"Path not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/paths/{id}":{"delete":{"summary":"Delete Path","description":"Delete a Path item by its id.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"delete-path-by-id","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Path identifier"},"required":true,"description":"Path identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Path deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorPath"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Path > Partially updates a Path item by its id.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorPath":{"description":"Path not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/paths/{id}":{"patch":{"summary":"Update Path","description":"Partially updates a Path item by its id.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"update-path-by-id","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Path identifier"},"required":true,"description":"Path identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Path item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2wcmmkwscvq","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Path updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorPath"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Paths > List all Paths items.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/paths":{"get":{"summary":"List Paths","description":"List all Paths items.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"list-paths1","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Paths","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Path"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Paths collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Path > Create a new Path item.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/paths":{"post":{"summary":"Create Path","description":"Create a new Path item.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"create-path1","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Path item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"responses":{"201":{"description":"Path created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Path > Get a Path item by its id.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorPath":{"description":"Path not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/paths/{id}":{"get":{"summary":"Get Path","description":"Get a Path item by its id.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"get-path-by-id1","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Path identifier"},"required":true,"description":"Path identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Path details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorPath"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Path > Completely replaces a Path item by its id.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorPath":{"description":"Path not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/paths/{id}":{"post":{"summary":"Replace Path","description":"Completely replaces a Path item by its id.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"replace-path-by-id1","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Path identifier"},"required":true,"description":"Path identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Path item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"responses":{"200":{"description":"Path replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"201":{"description":"Path created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorPath"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Path > Delete a Path item by its id.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorPath":{"description":"Path not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/paths/{id}":{"delete":{"summary":"Delete Path","description":"Delete a Path item by its id.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"delete-path-by-id1","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Path identifier"},"required":true,"description":"Path identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Path deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorPath"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Path > Partially updates a Path item by its id.\ > \ > Path is an API path entry representing a templated URL segment and any metadata shared by its operations. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Paths"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorPath":{"description":"Path not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/paths/{id}":{"patch":{"summary":"Update Path","description":"Partially updates a Path item by its id.\n\nPath is an API path entry representing a templated URL segment and any metadata shared by its operations.","operationId":"update-path-by-id1","tags":["Paths"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Path identifier"},"required":true,"description":"Path identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Path item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2xdwteezm7y","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Path updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Path"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorPath"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Operations ## List Operations > List all Operations items.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/operations":{"get":{"summary":"List Operations","description":"List all Operations items.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"list-operations","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Operations","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Operations collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Operation > Create a new Operation item.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/operations":{"post":{"summary":"Create Operation","description":"Create a new Operation item.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"create-operation","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Operation item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"responses":{"201":{"description":"Operation created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Operation > Get a Operation item by its id.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorOperation":{"description":"Operation not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/operations/{id}":{"get":{"summary":"Get Operation","description":"Get a Operation item by its id.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"get-operation-by-id","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":29,"maxLength":29,"description":"Operation identifier"},"required":true,"description":"Operation identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Operation details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorOperation"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Operation > Completely replaces a Operation item by its id.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorOperation":{"description":"Operation not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/operations/{id}":{"post":{"summary":"Replace Operation","description":"Completely replaces a Operation item by its id.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"replace-operation-by-id","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":29,"maxLength":29,"description":"Operation identifier"},"required":true,"description":"Operation identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Operation item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"responses":{"200":{"description":"Operation replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"201":{"description":"Operation created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorOperation"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Operation > Delete a Operation item by its id.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorOperation":{"description":"Operation not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/operations/{id}":{"delete":{"summary":"Delete Operation","description":"Delete a Operation item by its id.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"delete-operation-by-id","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":29,"maxLength":29,"description":"Operation identifier"},"required":true,"description":"Operation identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Operation deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorOperation"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Operation > Partially updates a Operation item by its id.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorOperation":{"description":"Operation not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/operations/{id}":{"patch":{"summary":"Update Operation","description":"Partially updates a Operation item by its id.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"update-operation-by-id","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":29,"maxLength":29,"description":"Operation identifier"},"required":true,"description":"Operation identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Operation item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2zglbgr5nby","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Operation updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorOperation"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Operations > List all Operations items.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/operations":{"get":{"summary":"List Operations","description":"List all Operations items.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"list-operations1","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Operations","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Operations collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Operation > Create a new Operation item.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/operations":{"post":{"summary":"Create Operation","description":"Create a new Operation item.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"create-operation1","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Operation item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"responses":{"201":{"description":"Operation created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Operation > Get a Operation item by its id.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorOperation":{"description":"Operation not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/operations/{id}":{"get":{"summary":"Get Operation","description":"Get a Operation item by its id.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"get-operation-by-id1","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":29,"maxLength":29,"description":"Operation identifier"},"required":true,"description":"Operation identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Operation details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorOperation"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Operation > Completely replaces a Operation item by its id.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorOperation":{"description":"Operation not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/operations/{id}":{"post":{"summary":"Replace Operation","description":"Completely replaces a Operation item by its id.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"replace-operation-by-id1","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":29,"maxLength":29,"description":"Operation identifier"},"required":true,"description":"Operation identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Operation item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"responses":{"200":{"description":"Operation replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"201":{"description":"Operation created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorOperation"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Operation > Delete a Operation item by its id.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorOperation":{"description":"Operation not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/operations/{id}":{"delete":{"summary":"Delete Operation","description":"Delete a Operation item by its id.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"delete-operation-by-id1","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":29,"maxLength":29,"description":"Operation identifier"},"required":true,"description":"Operation identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Operation deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorOperation"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Operation > Partially updates a Operation item by its id.\ > \ > Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Operations"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorOperation":{"description":"Operation not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/operations/{id}":{"patch":{"summary":"Update Operation","description":"Partially updates a Operation item by its id.\n\nOperation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.","operationId":"update-operation-by-id1","tags":["Operations"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":29,"maxLength":29,"description":"Operation identifier"},"required":true,"description":"Operation identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Operation item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb22ko7rb4lve","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Operation updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorOperation"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Parameters ## List Parameters > List all Parameters items.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/parameters":{"get":{"summary":"List Parameters","description":"List all Parameters items.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"list-parameters","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Parameters collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Parameter > Create a new Parameter item.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/parameters":{"post":{"summary":"Create Parameter","description":"Create a new Parameter item.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"create-parameter","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Parameter item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"responses":{"201":{"description":"Parameter created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Parameter > Get a Parameter item by its id.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorParameter":{"description":"Parameter not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/parameters/{id}":{"get":{"summary":"Get Parameter","description":"Get a Parameter item by its id.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"get-parameter-by-id","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Parameter identifier"},"required":true,"description":"Parameter identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Parameter details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorParameter"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Parameter > Completely replaces a Parameter item by its id.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorParameter":{"description":"Parameter not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/parameters/{id}":{"post":{"summary":"Replace Parameter","description":"Completely replaces a Parameter item by its id.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"replace-parameter-by-id","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Parameter identifier"},"required":true,"description":"Parameter identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Parameter item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"responses":{"200":{"description":"Parameter replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"201":{"description":"Parameter created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorParameter"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Parameter > Delete a Parameter item by its id.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorParameter":{"description":"Parameter not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/parameters/{id}":{"delete":{"summary":"Delete Parameter","description":"Delete a Parameter item by its id.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"delete-parameter-by-id","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Parameter identifier"},"required":true,"description":"Parameter identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Parameter deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorParameter"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Parameter > Partially updates a Parameter item by its id.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorParameter":{"description":"Parameter not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/parameters/{id}":{"patch":{"summary":"Update Parameter","description":"Partially updates a Parameter item by its id.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"update-parameter-by-id","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Parameter identifier"},"required":true,"description":"Parameter identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Parameter item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb24nvqave6gu","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Parameter updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorParameter"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Parameters > List all Parameters items.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/parameters":{"get":{"summary":"List Parameters","description":"List all Parameters items.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"list-parameters1","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Parameters","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Parameters collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Parameter > Create a new Parameter item.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/parameters":{"post":{"summary":"Create Parameter","description":"Create a new Parameter item.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"create-parameter1","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Parameter item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"responses":{"201":{"description":"Parameter created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Parameter > Get a Parameter item by its id.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorParameter":{"description":"Parameter not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/parameters/{id}":{"get":{"summary":"Get Parameter","description":"Get a Parameter item by its id.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"get-parameter-by-id1","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Parameter identifier"},"required":true,"description":"Parameter identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Parameter details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorParameter"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Parameter > Completely replaces a Parameter item by its id.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorParameter":{"description":"Parameter not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/parameters/{id}":{"post":{"summary":"Replace Parameter","description":"Completely replaces a Parameter item by its id.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"replace-parameter-by-id1","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Parameter identifier"},"required":true,"description":"Parameter identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Parameter item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"responses":{"200":{"description":"Parameter replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"201":{"description":"Parameter created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorParameter"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Parameter > Delete a Parameter item by its id.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorParameter":{"description":"Parameter not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/parameters/{id}":{"delete":{"summary":"Delete Parameter","description":"Delete a Parameter item by its id.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"delete-parameter-by-id1","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Parameter identifier"},"required":true,"description":"Parameter identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Parameter deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorParameter"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Parameter > Partially updates a Parameter item by its id.\ > \ > Parameter is a reusable request parameter definition scoped to a path or a single operation. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Parameters"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorParameter":{"description":"Parameter not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/parameters/{id}":{"patch":{"summary":"Update Parameter","description":"Partially updates a Parameter item by its id.\n\nParameter is a reusable request parameter definition scoped to a path or a single operation.","operationId":"update-parameter-by-id1","tags":["Parameters"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Parameter identifier"},"required":true,"description":"Parameter identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Parameter item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb25ksa56dz7i","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Parameter updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parameter"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorParameter"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Requests ## List Requests > List all Requests items.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/requests":{"get":{"summary":"List Requests","description":"List all Requests items.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"list-requests","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Requests","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Request"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Requests collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Request > Create a new Request item.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/requests":{"post":{"summary":"Create Request","description":"Create a new Request item.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"create-request","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Request item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"responses":{"201":{"description":"Request created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Request > Get a Request item by its id.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorRequest":{"description":"Request not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/requests/{id}":{"get":{"summary":"Get Request","description":"Get a Request item by its id.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"get-request-by-id","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Request identifier"},"required":true,"description":"Request identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Request details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Request > Completely replaces a Request item by its id.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorRequest":{"description":"Request not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/requests/{id}":{"post":{"summary":"Replace Request","description":"Completely replaces a Request item by its id.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"replace-request-by-id","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Request identifier"},"required":true,"description":"Request identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Request item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"responses":{"200":{"description":"Request replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"201":{"description":"Request created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Request > Delete a Request item by its id.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorRequest":{"description":"Request not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/requests/{id}":{"delete":{"summary":"Delete Request","description":"Delete a Request item by its id.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"delete-request-by-id","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Request identifier"},"required":true,"description":"Request identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Request deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Request > Partially updates a Request item by its id.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorRequest":{"description":"Request not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/requests/{id}":{"patch":{"summary":"Update Request","description":"Partially updates a Request item by its id.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"update-request-by-id","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Request identifier"},"required":true,"description":"Request identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Request item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb27fvophbnzy","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Request updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Requests > List all Requests items.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests":{"get":{"summary":"List Requests","description":"List all Requests items.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"list-requests1","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Requests","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Request"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Requests collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Request > Create a new Request item.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests":{"post":{"summary":"Create Request","description":"Create a new Request item.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"create-request1","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Request item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"responses":{"201":{"description":"Request created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Request > Get a Request item by its id.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorRequest":{"description":"Request not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests/{id}":{"get":{"summary":"Get Request","description":"Get a Request item by its id.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"get-request-by-id1","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Request identifier"},"required":true,"description":"Request identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Request details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Request > Completely replaces a Request item by its id.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorRequest":{"description":"Request not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests/{id}":{"post":{"summary":"Replace Request","description":"Completely replaces a Request item by its id.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"replace-request-by-id1","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Request identifier"},"required":true,"description":"Request identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Request item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"responses":{"200":{"description":"Request replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"201":{"description":"Request created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Request > Delete a Request item by its id.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorRequest":{"description":"Request not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests/{id}":{"delete":{"summary":"Delete Request","description":"Delete a Request item by its id.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"delete-request-by-id1","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Request identifier"},"required":true,"description":"Request identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Request deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Request > Partially updates a Request item by its id.\ > \ > Request is an operation request body definition including MIME type, payload shape, headers, and examples. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Requests"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."},"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorRequest":{"description":"Request not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests/{id}":{"patch":{"summary":"Update Request","description":"Partially updates a Request item by its id.\n\nRequest is an operation request body definition including MIME type, payload shape, headers, and examples.","operationId":"update-request-by-id1","tags":["Requests"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Request identifier"},"required":true,"description":"Request identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Request item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb3aj2vhs2do4","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Request updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorRequest"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Responses ## List Responses > List all Responses items.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/responses":{"get":{"summary":"List Responses","description":"List all Responses items.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"list-responses","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Responses","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Response"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Responses collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Response > Create a new Response item.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/responses":{"post":{"summary":"Create Response","description":"Create a new Response item.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"create-response","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Response item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"responses":{"201":{"description":"Response created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Response > Get a Response item by its id.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResponse":{"description":"Response not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/responses/{id}":{"get":{"summary":"Get Response","description":"Get a Response item by its id.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"get-response-by-id","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Response identifier"},"required":true,"description":"Response identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Response details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Response > Completely replaces a Response item by its id.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResponse":{"description":"Response not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/responses/{id}":{"post":{"summary":"Replace Response","description":"Completely replaces a Response item by its id.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"replace-response-by-id","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Response identifier"},"required":true,"description":"Response identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Response item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"responses":{"200":{"description":"Response replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"201":{"description":"Response created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Response > Delete a Response item by its id.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResponse":{"description":"Response not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/responses/{id}":{"delete":{"summary":"Delete Response","description":"Delete a Response item by its id.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"delete-response-by-id","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Response identifier"},"required":true,"description":"Response identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Response deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Response > Partially updates a Response item by its id.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResponse":{"description":"Response not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/responses/{id}":{"patch":{"summary":"Update Response","description":"Partially updates a Response item by its id.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"update-response-by-id","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Response identifier"},"required":true,"description":"Response identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Response item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3cmc7qj2mya","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Response updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Responses > List all Responses items.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses":{"get":{"summary":"List Responses","description":"List all Responses items.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"list-responses1","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Responses","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Response"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Responses collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Response > Create a new Response item.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses":{"post":{"summary":"Create Response","description":"Create a new Response item.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"create-response1","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Response item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"responses":{"201":{"description":"Response created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Response > Get a Response item by its id.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResponse":{"description":"Response not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id}":{"get":{"summary":"Get Response","description":"Get a Response item by its id.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"get-response-by-id1","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Response identifier"},"required":true,"description":"Response identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Response details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Response > Completely replaces a Response item by its id.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResponse":{"description":"Response not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id}":{"post":{"summary":"Replace Response","description":"Completely replaces a Response item by its id.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"replace-response-by-id1","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Response identifier"},"required":true,"description":"Response identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Response item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"responses":{"200":{"description":"Response replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"201":{"description":"Response created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Response > Delete a Response item by its id.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResponse":{"description":"Response not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id}":{"delete":{"summary":"Delete Response","description":"Delete a Response item by its id.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"delete-response-by-id1","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Response identifier"},"required":true,"description":"Response identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Response deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Response > Partially updates a Response item by its id.\ > \ > Response is an operation response entry including status code, MIME type, payload shape, examples, and headers. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Responses"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."},"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResponse":{"description":"Response not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/responses/{id}":{"patch":{"summary":"Update Response","description":"Partially updates a Response item by its id.\n\nResponse is an operation response entry including status code, MIME type, payload shape, examples, and headers.","operationId":"update-response-by-id1","tags":["Responses"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Response identifier"},"required":true,"description":"Response identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Response item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3dhsjonvn4q","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Response updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Servers ## List Servers > List all Servers items.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/servers":{"get":{"summary":"List Servers","description":"List all Servers items.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"list-servers","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Servers","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Server"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Servers collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Server > Create a new Server item.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/servers":{"post":{"summary":"Create Server","description":"Create a new Server item.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"create-server","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Server item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"responses":{"201":{"description":"Server created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Server > Get a Server item by its id.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorServer":{"description":"Server not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/servers/{id}":{"get":{"summary":"Get Server","description":"Get a Server item by its id.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"get-server-by-id","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Server identifier"},"required":true,"description":"Server identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Server details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorServer"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Server > Completely replaces a Server item by its id.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorServer":{"description":"Server not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/servers/{id}":{"post":{"summary":"Replace Server","description":"Completely replaces a Server item by its id.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"replace-server-by-id","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Server identifier"},"required":true,"description":"Server identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Server item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"responses":{"200":{"description":"Server replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"201":{"description":"Server created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorServer"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Server > Delete a Server item by its id.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorServer":{"description":"Server not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/servers/{id}":{"delete":{"summary":"Delete Server","description":"Delete a Server item by its id.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"delete-server-by-id","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Server identifier"},"required":true,"description":"Server identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Server deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorServer"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Server > Partially updates a Server item by its id.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorServer":{"description":"Server not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/servers/{id}":{"patch":{"summary":"Update Server","description":"Partially updates a Server item by its id.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"update-server-by-id","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Server identifier"},"required":true,"description":"Server identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Server item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3feoo2ed3uy","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Server updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorServer"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Servers > List all Servers items.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/servers":{"get":{"summary":"List Servers","description":"List all Servers items.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"list-servers1","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Servers","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Server"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Servers collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Server > Create a new Server item.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/servers":{"post":{"summary":"Create Server","description":"Create a new Server item.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"create-server1","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Server item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"responses":{"201":{"description":"Server created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Server > Get a Server item by its id.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorServer":{"description":"Server not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/servers/{id}":{"get":{"summary":"Get Server","description":"Get a Server item by its id.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"get-server-by-id1","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Server identifier"},"required":true,"description":"Server identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Server details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorServer"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Server > Completely replaces a Server item by its id.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorServer":{"description":"Server not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/servers/{id}":{"post":{"summary":"Replace Server","description":"Completely replaces a Server item by its id.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"replace-server-by-id1","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Server identifier"},"required":true,"description":"Server identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Server item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"responses":{"200":{"description":"Server replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"201":{"description":"Server created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorServer"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Server > Delete a Server item by its id.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorServer":{"description":"Server not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/servers/{id}":{"delete":{"summary":"Delete Server","description":"Delete a Server item by its id.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"delete-server-by-id1","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Server identifier"},"required":true,"description":"Server identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Server deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorServer"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Server > Partially updates a Server item by its id.\ > \ > Server is an URL endpoint template attached to a service, path, or operation, including variables when needed. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Servers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."},"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorServer":{"description":"Server not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/servers/{id}":{"patch":{"summary":"Update Server","description":"Partially updates a Server item by its id.\n\nServer is an URL endpoint template attached to a service, path, or operation, including variables when needed.","operationId":"update-server-by-id1","tags":["Servers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Server identifier"},"required":true,"description":"Server identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Server item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3gbgi6vbiki","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Server updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Server"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorServer"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Security Schemes ## List Security Schemes > List all Security Schemes items.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/security-schemes":{"get":{"summary":"List Security Schemes","description":"List all Security Schemes items.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"list-security-schemes","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Security Schemes","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SecurityScheme"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Security Schemes collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Security Scheme > Create a new Security Scheme item.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/security-schemes":{"post":{"summary":"Create Security Scheme","description":"Create a new Security Scheme item.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"create-security-scheme","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Security Scheme item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"responses":{"201":{"description":"Security Scheme created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Security Scheme > Get a Security Scheme item by its id.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorSecurityScheme":{"description":"Security Scheme not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/security-schemes/{id}":{"get":{"summary":"Get Security Scheme","description":"Get a Security Scheme item by its id.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"get-security-scheme-by-id","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":34,"maxLength":34,"description":"Security Scheme identifier"},"required":true,"description":"Security Scheme identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Security Scheme details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorSecurityScheme"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Security Scheme > Completely replaces a Security Scheme item by its id.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorSecurityScheme":{"description":"Security Scheme not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/security-schemes/{id}":{"post":{"summary":"Replace Security Scheme","description":"Completely replaces a Security Scheme item by its id.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"replace-security-scheme-by-id","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":34,"maxLength":34,"description":"Security Scheme identifier"},"required":true,"description":"Security Scheme identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Security Scheme item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"responses":{"200":{"description":"Security Scheme replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"201":{"description":"Security Scheme created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorSecurityScheme"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Security Scheme > Delete a Security Scheme item by its id.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorSecurityScheme":{"description":"Security Scheme not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/security-schemes/{id}":{"delete":{"summary":"Delete Security Scheme","description":"Delete a Security Scheme item by its id.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"delete-security-scheme-by-id","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":34,"maxLength":34,"description":"Security Scheme identifier"},"required":true,"description":"Security Scheme identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Security Scheme deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorSecurityScheme"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Security Scheme > Partially updates a Security Scheme item by its id.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorSecurityScheme":{"description":"Security Scheme not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/security-schemes/{id}":{"patch":{"summary":"Update Security Scheme","description":"Partially updates a Security Scheme item by its id.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"update-security-scheme-by-id","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":34,"maxLength":34,"description":"Security Scheme identifier"},"required":true,"description":"Security Scheme identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Security Scheme item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3in7l6rxe2i","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":["string","null"],"enum":["query","header","cookie",null],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Security Scheme updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorSecurityScheme"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Security Schemes > List all Security Schemes items.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes":{"get":{"summary":"List Security Schemes","description":"List all Security Schemes items.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"list-security-schemes1","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Security Schemes","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SecurityScheme"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Security Schemes collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Security Scheme > Create a new Security Scheme item.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes":{"post":{"summary":"Create Security Scheme","description":"Create a new Security Scheme item.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"create-security-scheme1","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Security Scheme item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"responses":{"201":{"description":"Security Scheme created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Security Scheme > Get a Security Scheme item by its id.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorSecurityScheme":{"description":"Security Scheme not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes/{id}":{"get":{"summary":"Get Security Scheme","description":"Get a Security Scheme item by its id.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"get-security-scheme-by-id1","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":34,"maxLength":34,"description":"Security Scheme identifier"},"required":true,"description":"Security Scheme identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Security Scheme details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorSecurityScheme"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Security Scheme > Completely replaces a Security Scheme item by its id.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorSecurityScheme":{"description":"Security Scheme not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes/{id}":{"post":{"summary":"Replace Security Scheme","description":"Completely replaces a Security Scheme item by its id.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"replace-security-scheme-by-id1","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":34,"maxLength":34,"description":"Security Scheme identifier"},"required":true,"description":"Security Scheme identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Security Scheme item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"responses":{"200":{"description":"Security Scheme replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"201":{"description":"Security Scheme created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorSecurityScheme"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Security Scheme > Delete a Security Scheme item by its id.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorSecurityScheme":{"description":"Security Scheme not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes/{id}":{"delete":{"summary":"Delete Security Scheme","description":"Delete a Security Scheme item by its id.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"delete-security-scheme-by-id1","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":34,"maxLength":34,"description":"Security Scheme identifier"},"required":true,"description":"Security Scheme identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Security Scheme deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorSecurityScheme"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Security Scheme > Partially updates a Security Scheme item by its id.\ > \ > SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Security Schemes"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorSecurityScheme":{"description":"Security Scheme not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes/{id}":{"patch":{"summary":"Update Security Scheme","description":"Partially updates a Security Scheme item by its id.\n\nSecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.","operationId":"update-security-scheme-by-id1","tags":["Security Schemes"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":34,"maxLength":34,"description":"Security Scheme identifier"},"required":true,"description":"Security Scheme identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Security Scheme item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3jfszwxcfl4","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":["string","null"],"enum":["query","header","cookie",null],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Security Scheme updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityScheme"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorSecurityScheme"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Headers ## List Headers > List all Headers items.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/headers":{"get":{"summary":"List Headers","description":"List all Headers items.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"list-headers","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Headers","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Header"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Headers collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Header > Create a new Header item.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/headers":{"post":{"summary":"Create Header","description":"Create a new Header item.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"create-header","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Header item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"responses":{"201":{"description":"Header created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Header > Get a Header item by its id.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorHeader":{"description":"Header not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/headers/{id}":{"get":{"summary":"Get Header","description":"Get a Header item by its id.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"get-header-by-id","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Header identifier"},"required":true,"description":"Header identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Header details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorHeader"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Header > Completely replaces a Header item by its id.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorHeader":{"description":"Header not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/headers/{id}":{"post":{"summary":"Replace Header","description":"Completely replaces a Header item by its id.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"replace-header-by-id","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Header identifier"},"required":true,"description":"Header identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Header item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"responses":{"200":{"description":"Header replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"201":{"description":"Header created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorHeader"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Header > Delete a Header item by its id.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorHeader":{"description":"Header not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/headers/{id}":{"delete":{"summary":"Delete Header","description":"Delete a Header item by its id.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"delete-header-by-id","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Header identifier"},"required":true,"description":"Header identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Header deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorHeader"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Header > Partially updates a Header item by its id.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorHeader":{"description":"Header not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/headers/{id}":{"patch":{"summary":"Update Header","description":"Partially updates a Header item by its id.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"update-header-by-id","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Header identifier"},"required":true,"description":"Header identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Header item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3lezitsa2ki","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}}}}}},"responses":{"200":{"description":"Header updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorHeader"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Headers > List all Headers items.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers":{"get":{"summary":"List Headers","description":"List all Headers items.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"list-headers1","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Headers","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Header"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Headers collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Header > Create a new Header item.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers":{"post":{"summary":"Create Header","description":"Create a new Header item.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"create-header1","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Header item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"responses":{"201":{"description":"Header created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Header > Get a Header item by its id.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorHeader":{"description":"Header not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id}":{"get":{"summary":"Get Header","description":"Get a Header item by its id.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"get-header-by-id1","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Header identifier"},"required":true,"description":"Header identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Header details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorHeader"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Header > Completely replaces a Header item by its id.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorHeader":{"description":"Header not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id}":{"post":{"summary":"Replace Header","description":"Completely replaces a Header item by its id.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"replace-header-by-id1","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Header identifier"},"required":true,"description":"Header identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Header item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"responses":{"200":{"description":"Header replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"201":{"description":"Header created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorHeader"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Header > Delete a Header item by its id.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorHeader":{"description":"Header not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id}":{"delete":{"summary":"Delete Header","description":"Delete a Header item by its id.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"delete-header-by-id1","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Header identifier"},"required":true,"description":"Header identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Header deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorHeader"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Header > Partially updates a Header item by its id.\ > \ > Header is a reusable HTTP header definition with schema, examples, and optional structured content. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Headers"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."},"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorHeader":{"description":"Header not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id}":{"patch":{"summary":"Update Header","description":"Partially updates a Header item by its id.\n\nHeader is a reusable HTTP header definition with schema, examples, and optional structured content.","operationId":"update-header-by-id1","tags":["Headers"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Header identifier"},"required":true,"description":"Header identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Header item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3moe6ajpppm","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}}}}}},"responses":{"200":{"description":"Header updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Header"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorHeader"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Examples ## List Examples > List all Examples items.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/examples":{"get":{"summary":"List Examples","description":"List all Examples items.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"list-examples","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Examples","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Example"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Examples collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Example > Create a new Example item.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/examples":{"post":{"summary":"Create Example","description":"Create a new Example item.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"create-example","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Example item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"responses":{"201":{"description":"Example created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Example > Get a Example item by its id.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorExample":{"description":"Example not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/examples/{id}":{"get":{"summary":"Get Example","description":"Get a Example item by its id.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"get-example-by-id","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Example identifier"},"required":true,"description":"Example identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Example details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorExample"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Example > Completely replaces a Example item by its id.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorExample":{"description":"Example not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/examples/{id}":{"post":{"summary":"Replace Example","description":"Completely replaces a Example item by its id.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"replace-example-by-id","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Example identifier"},"required":true,"description":"Example identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Example item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"responses":{"200":{"description":"Example replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"201":{"description":"Example created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorExample"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Example > Delete a Example item by its id.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorExample":{"description":"Example not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/examples/{id}":{"delete":{"summary":"Delete Example","description":"Delete a Example item by its id.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"delete-example-by-id","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Example identifier"},"required":true,"description":"Example identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Example deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorExample"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Example > Partially updates a Example item by its id.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorExample":{"description":"Example not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/examples/{id}":{"patch":{"summary":"Update Example","description":"Partially updates a Example item by its id.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"update-example-by-id","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Example identifier"},"required":true,"description":"Example identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Example item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3ookifvvcmm","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Example updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorExample"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Examples > List all Examples items.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/examples":{"get":{"summary":"List Examples","description":"List all Examples items.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"list-examples1","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Examples","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Example"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Examples collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Example > Create a new Example item.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/examples":{"post":{"summary":"Create Example","description":"Create a new Example item.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"create-example1","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Example item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"responses":{"201":{"description":"Example created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Example > Get a Example item by its id.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorExample":{"description":"Example not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/examples/{id}":{"get":{"summary":"Get Example","description":"Get a Example item by its id.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"get-example-by-id1","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Example identifier"},"required":true,"description":"Example identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Example details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorExample"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Example > Completely replaces a Example item by its id.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorExample":{"description":"Example not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/examples/{id}":{"post":{"summary":"Replace Example","description":"Completely replaces a Example item by its id.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"replace-example-by-id1","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Example identifier"},"required":true,"description":"Example identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Example item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"responses":{"200":{"description":"Example replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"201":{"description":"Example created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorExample"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Example > Delete a Example item by its id.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorExample":{"description":"Example not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/examples/{id}":{"delete":{"summary":"Delete Example","description":"Delete a Example item by its id.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"delete-example-by-id1","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Example identifier"},"required":true,"description":"Example identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Example deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorExample"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Example > Partially updates a Example item by its id.\ > \ > Example is a reusable example that holds either an inline payload or an external reference for request or response bodies. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Examples"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorExample":{"description":"Example not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/examples/{id}":{"patch":{"summary":"Update Example","description":"Partially updates a Example item by its id.\n\nExample is a reusable example that holds either an inline payload or an external reference for request or response bodies.","operationId":"update-example-by-id1","tags":["Examples"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":31,"maxLength":31,"description":"Example identifier"},"required":true,"description":"Example identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Example item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3pljxeetm3u","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}}}}}},"responses":{"200":{"description":"Example updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Example"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorExample"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Assistant ## Chat with catalog assistant > Streaming AI assistant that answers questions about the API catalog using tools to query services and their details. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Assistant"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"AssistantMessagesSchema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["system","user","assistant"]},"parts":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"state":{"type":"string","enum":["streaming","done"]},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["reasoning"]},"text":{"type":"string"},"state":{"type":"string","enum":["streaming","done"]},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["file"]},"mediaType":{"type":"string"},"url":{"type":"string"},"filename":{"type":"string"},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","mediaType","url"]},{"type":"object","properties":{"type":{"type":"string","minLength":1}},"required":["type"],"additionalProperties":{}}]}},"metadata":{"type":"object","additionalProperties":{}}},"required":["role","parts"]},"description":"Conversation messages for the AI assistant"}},"required":["messages"],"description":"AI-sdk structured conversation payload for the AI assistant"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/assistant":{"post":{"summary":"Chat with catalog assistant","description":"Streaming AI assistant that answers questions about the API catalog using tools to query services and their details.","operationId":"post-assistant","tags":["Assistant"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssistantMessagesSchema"}}}},"responses":{"200":{"description":"Server-sent events stream of AI assistant response","content":{"text/event-stream":{"schema":{"description":"AI-sdk protocol streaming response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Chat with catalog assistant > Streaming AI assistant that answers questions about the API catalog using tools to query services and their details. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Assistant"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"AssistantMessagesSchema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["system","user","assistant"]},"parts":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"state":{"type":"string","enum":["streaming","done"]},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["reasoning"]},"text":{"type":"string"},"state":{"type":"string","enum":["streaming","done"]},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["file"]},"mediaType":{"type":"string"},"url":{"type":"string"},"filename":{"type":"string"},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","mediaType","url"]},{"type":"object","properties":{"type":{"type":"string","minLength":1}},"required":["type"],"additionalProperties":{}}]}},"metadata":{"type":"object","additionalProperties":{}}},"required":["role","parts"]},"description":"Conversation messages for the AI assistant"}},"required":["messages"],"description":"AI-sdk structured conversation payload for the AI assistant"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/assistant":{"post":{"summary":"Chat with catalog assistant","description":"Streaming AI assistant that answers questions about the API catalog using tools to query services and their details.","operationId":"post-assistant","tags":["Assistant"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssistantMessagesSchema"}}}},"responses":{"200":{"description":"Server-sent events stream of AI assistant response","content":{"text/event-stream":{"schema":{"description":"AI-sdk protocol streaming response"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` # Models ## The versionId object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}}}} ``` ## The projectRef object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"}}}} ``` ## The versionType object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"}}}} ``` ## The versionSlug object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}}}} ``` ## The Service object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Service":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"svc_agqatw3xir2znbb2pdj6rwp6zy","description":"Object ID with prefix \"svc_\""},"name":{"type":"string","default":""},"slug":{"type":"string","pattern":"^[a-z0-9-]+$"},"summary":{"type":"string","default":"","description":"Short plain-text summary of the service."},"description":{"type":"string","default":"","description":"Service description written in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Service description as ProseMirror JSON blocks."},"tags":{"type":"array","items":{"type":"string"},"default":[]},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements shared by every endpoint in the service. Each item maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"previousSlugs":{"type":"array","items":{"type":"string"},"default":[]},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"organizationId":{"type":"string"},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the service; kept intact when exporting or importing API docs."},"lastReportAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the most recent report received from the service."},"lastMentionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp when the service was last mentioned in a report, either directly or via connected services."},"lastConnectionAt":{"type":["string","null"],"format":"date-time","description":"Timestamp of the last successful connection observed from the service (ping or report)."},"hasConnection":{"type":"boolean","default":false,"description":"Indicates that the service maintains a direct connection from which reports are expected."}},"required":["slug","versionId","organizationId"],"description":"Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}}}} ``` ## The ProseMirrorContentSchema object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}}}} ``` ## The PaginationMetadata object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}}}} ``` ## The Resource object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agqatw3xir2znbb2snv6aq4jhe","description":"Object ID with prefix \"rsc_\""},"name":{"type":"string","default":"","description":"Resource name, typically the same key used when the schema is referenced in API definitions."},"description":{"type":"string","description":"Description of what this reusable schema represents (markdown)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured schema describing the reusable object shape."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata stored with the schema (such as vendor-specific extensions)."},"createdAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId","schema"],"description":"Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}}}} ``` ## The AnyJsonSchema object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}}}} ``` ## The Path object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Path":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"path_agqatw3xir2znbb2vgfnsamedu","description":"Object ID with prefix \"path_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"svc_\""},"path":{"type":"string","description":"Concrete API path template (must start with a forward slash)."},"summary":{"type":"string","description":"Short summary of the path across its operations."},"description":{"type":"string","description":"Long-form description of the path shared across operations (markdown)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata kept with the path (including any x-... style extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["serviceId","path","versionId"],"description":"Path is an API path entry representing a templated URL segment and any metadata shared by its operations."}}}} ``` ## The Operation object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Operation":{"type":"object","properties":{"id":{"type":"string","minLength":29,"maxLength":29,"default":"op_agqatw3xir2znbb2yigtkb7gpe","description":"Object ID with prefix \"op_\""},"method":{"type":"string","description":"HTTP method for the operation (e.g., get, post)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"path_\""},"summary":{"type":"string","description":"Short summary of the operation."},"description":{"type":"string","description":"Markdown description of the operation."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Operation description represented as ProseMirror JSON."},"deprecated":{"type":"boolean","default":false},"operationId":{"type":"string","description":"Stable operation identifier mirroring OpenAPI operationId."},"tags":{"type":"array","items":{"type":"string"},"default":[],"description":"Tags applied to the operation for grouping."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata attached to the operation; kept when importing/exporting API definitions."},"security":{"type":"array","items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"description":"Authentication requirements for this operation; each entry maps a security scheme id to the scopes/permissions it needs.","url":"https://swagger.io/specification/#security-requirement-object"},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["method","pathId","operationId","versionId"],"description":"Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}}}} ``` ## The Parameter object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Parameter":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"par_agqatw3xir2znbb23p6za4lsae","description":"Object ID with prefix \"par_\""},"name":{"type":"string","minLength":1,"description":"Parameter name as exposed in the API (case-sensitive for header names)."},"description":{"type":"string","description":"Human-readable description of what the parameter controls (markdown)."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Set when the parameter applies to every operation on a path."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Set when the parameter is specific to a single operation."},"deprecated":{"type":"boolean","default":false},"required":{"type":"boolean","default":false},"in":{"type":"string","enum":["query","header","path","cookie"],"description":"Location of the parameter (query, header, path, or cookie)."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the parameter value (type, format, constraints)."},"allowEmptyValue":{"type":"boolean","default":false,"description":"Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).","deprecated":true},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried through from imported/published API definitions."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["name","in","schema","versionId"],"description":"Parameter is a reusable request parameter definition scoped to a path or a single operation."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}}}} ``` ## The ExternalExample object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"ExternalExample":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"externalValue":{"type":"string"}},"required":["externalValue"],"description":"Example that points to an external payload instead of embedding it."}}}} ``` ## The EmbeddedExample object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"EmbeddedExample":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"value":{}},"description":"Example with an embedded payload for a specific content type."}}}} ``` ## The Request object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Request":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"req_agqatw3xir2znbb26dyflunmee","description":"Object ID with prefix \"req_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"description":{"type":"string","description":"Markdown description of the request."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Request description in ProseMirror JSON."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the request body (for example, application/json); null means the request has no body."},"headers":{"$ref":"#/components/schemas/RequestHeaders"},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"Structured shape of the request payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the request body, including encoding details."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Request is an operation request body definition including MIME type, payload shape, headers, and examples."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}}}} ``` ## The RequestHeaders object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"RequestHeaders":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/RequestHeaderRef"}]},"default":{},"description":"Headers expected on the request. Presence here documents expectations and does not imply they are required or change server behavior (e.g., X-Correlation-Id for traceability)."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}}}} ``` ## The InlineHeader object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}}}} ``` ## The InlineExamples object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"InlineExamples":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ExternalExample"},{"$ref":"#/components/schemas/EmbeddedExample"}]},"description":"Map of example definitions keyed by name, matching how examples are referenced in API specs."},"ExternalExample":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"externalValue":{"type":"string"}},"required":["externalValue"],"description":"Example that points to an external payload instead of embedding it."},"EmbeddedExample":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"value":{}},"description":"Example with an embedded payload for a specific content type."}}}} ``` ## The RequestHeaderRef object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"RequestHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}}}} ``` ## The Response object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Response":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"res_agqatw3xir2znbb3bodhkwn6z4","description":"Object ID with prefix \"res_\""},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Object ID with prefix \"op_\""},"statusCode":{"anyOf":[{"type":"null"},{"type":["number","null"]}],"description":"HTTP status code; null denotes the default response."},"description":{"type":"string","description":"Markdown description of the response."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Response description in ProseMirror JSON format."},"contentMediaType":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"MIME type of the response body (for example, application/json); null means the response has no body."},"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"Structured shape of the response payload (types, required fields, constraints)."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata captured from the response definition."},"headers":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/InlineHeader"},{"$ref":"#/components/schemas/ResponseHeaderRef"}]},"default":{},"description":"Headers returned with the response, keyed by header name."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["operationId","versionId"],"description":"Response is an operation response entry including status code, MIME type, payload shape, examples, and headers."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"InlineHeader":{"type":"object","properties":{"description":{"type":"string","description":"Header description when defined inline on a request/response."},"required":{"type":"boolean","default":false},"deprecated":{"type":"boolean","default":false},"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"description":"Inline header definition used inside requests or responses."},"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}}}} ``` ## The ResponseHeaderRef object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"ResponseHeaderRef":{"type":"object","properties":{"$ref":{"type":"string"}},"required":["$ref"],"description":"Reference to a reusable header component."}}}} ``` ## The Server object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Server":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"srv_agqatw3xir2znbb3ek37cbuuj4","description":"Object ID with prefix \"srv_\""},"serviceId":{"type":"string","minLength":30,"maxLength":30,"description":"Server scoped to a service; cannot be combined with pathId or operationId."},"pathId":{"type":"string","minLength":31,"maxLength":31,"description":"Server scoped to a specific path; cannot be combined with serviceId or operationId."},"operationId":{"type":"string","minLength":29,"maxLength":29,"description":"Server scoped to a single operation; cannot be combined with serviceId or pathId."},"url":{"type":"string","description":"Base URL template for calling the API (may include `{variable}` placeholders)."},"description":{"type":"string","description":"Markdown description of the server."},"variables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServerVariable"},"default":{},"description":"Map of variables that the server URL template expects."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the server definition."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["url","versionId"],"description":"Server is an URL endpoint template attached to a service, path, or operation, including variables when needed."},"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."}}}} ``` ## The ServerVariable object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"ServerVariable":{"type":"object","properties":{"enum":{"type":"array","items":{"type":"string"},"minItems":1},"default":{"type":"string"},"description":{"type":"string"}},"required":["default"],"description":"Variable in the server URL, with a default value and optional allowed values."}}}} ``` ## The SecurityScheme object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"SecurityScheme":{"type":"object","properties":{"id":{"type":"string","minLength":34,"maxLength":34,"default":"sec_sch_agqatw3xir2znbb3hlreoni254","description":"Object ID with prefix \"sec_sch_\""},"type":{"type":"string","enum":["apiKey","http","mutualTls","oauth2","openIdConnect"],"description":"Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect)."},"in":{"type":"string","enum":["query","header","cookie"],"description":"Location of the API key for apiKey schemes (query, header, or cookie)."},"name":{"type":"string","description":"Identifier for the security scheme; matches the name used when publishing or importing API definitions."},"description":{"type":"string","description":"Security scheme description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Security scheme description in ProseMirror JSON blocks."},"scheme":{"type":"string","description":"HTTP auth scheme label (for example: basic, bearer, digest)."},"bearerFormat":{"type":"string","description":"Optional hint about the bearer token format (for example: JWT)."},"flows":{"description":"OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs."},"openIdConnectUrl":{"type":"string","description":"OpenID Connect discovery endpoint when type is openIdConnect."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["type","name","versionId"],"description":"SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}}}} ``` ## The Header object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Header":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"head_agqatw3xir2znbb3kj4h77oyq4","description":"Object ID with prefix \"head_\""},"name":{"type":"string","description":"Header name; case-insensitive when serialized in HTTP."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"},"description":{"type":"string","description":"Plain description of what the header conveys."},"required":{"type":"boolean","description":"Marks the header as required for the request or response."},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"],"description":"Serialization style for the header (simple = comma-separated)."},"explode":{"type":"boolean","description":"Controls whether arrays/objects are split into separate values instead of a single combined string."},"schema":{"$ref":"#/components/schemas/AnyJsonSchema","description":"JSON Schema describing the header value."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata preserved with the header definition."},"content":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderContent"},"description":"Map of content types to header definitions when the header carries structured content."}},"required":["name","versionId"],"description":"Header is a reusable HTTP header definition with schema, examples, and optional structured content."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."}}}} ``` ## The HeaderContent object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"HeaderContent":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":["schema"],"description":"Alternate structured content for the header keyed by content type."},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."}}}} ``` ## The Example object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"Example":{"type":"object","properties":{"id":{"type":"string","minLength":31,"maxLength":31,"default":"expl_agqatw3xir2znbb3nkko4ker4a","description":"Object ID with prefix \"expl_\""},"name":{"type":"string","description":"Non-unique name of a reusable example; matches how it is referenced in API definitions."},"value":{"description":"Inline example payload for the referenced content type."},"externalValue":{"type":"string","description":"URL pointing to an external example payload."},"summary":{"type":"string"},"description":{"type":"string","description":"Example description in markdown."},"descriptionBlocks":{"anyOf":[{"$ref":"#/components/schemas/ProseMirrorContentSchema"},{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}}],"description":"Example description in ProseMirror JSON blocks."},"kvStorage":{"type":"object","additionalProperties":{},"default":{},"description":"Custom metadata carried with the example (e.g., vendor-specific extensions)."},"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Object ID with prefix \"ver_\""},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-08-16T09:16:12.996Z"}},"required":["versionId"],"description":"Example is a reusable example that holds either an inline payload or an external reference for request or response bodies."},"ProseMirrorContentSchema":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}},"content":{"type":"array","items":{"$ref":"#/components/schemas/ProseMirrorContentSchema"}},"marks":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"attrs":{"type":"object","additionalProperties":{}}},"required":["type"],"additionalProperties":{}}},"text":{"type":"string"}},"additionalProperties":{},"description":"A recursive schema modeling ProseMirror document/node structure. It mirrors the ProseMirror JSON format as described at https://prosemirror.net/docs/guide/#schema.serialization. Each node may contain a `type`, optional `attrs`, children in `content`, formatting `marks`, and inline `text`."}}}} ``` ## The AssistantMessagesSchema object ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"components":{"schemas":{"AssistantMessagesSchema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["system","user","assistant"]},"parts":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"state":{"type":"string","enum":["streaming","done"]},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["reasoning"]},"text":{"type":"string"},"state":{"type":"string","enum":["streaming","done"]},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["file"]},"mediaType":{"type":"string"},"url":{"type":"string"},"filename":{"type":"string"},"providerMetadata":{"type":"object","additionalProperties":{}}},"required":["type","mediaType","url"]},{"type":"object","properties":{"type":{"type":"string","minLength":1}},"required":["type"],"additionalProperties":{}}]}},"metadata":{"type":"object","additionalProperties":{}}},"required":["role","parts"]},"description":"Conversation messages for the AI assistant"}},"required":["messages"],"description":"AI-sdk structured conversation payload for the AI assistant"}}}} ``` # Resource map The resource map visually represents how the resources within your services are related.

Each service has its own resource map.

Each API service in Appear has its own **Resource Map**, which clearly visualises how API resources relate to one another. These maps help developers understand **hierarchies, dependencies, and data flows** across their API. #### **Key Features** * **Environment & Branch Views** – See a dedicated resource map for each environment or branch. * **Interactive Exploration** – Click on a resource card to highlight its relationships. * **Search & Navigation** – Quickly find specific resources within the map. * **Zoom & Pan Controls** – Adjust your view to explore large API structures easily.

Searching for resources will highlight them in the UI.

#### **Why Use a Resource Map?** * **Understand API Structure** – Visualize how resources connect (e.g., `users → orders → transactions`). * **Navigate APIs Faster** – Locate endpoints without digging through documentation. * **Optimize & Debug** – Identify redundant endpoints, troubleshoot issues, and improve API design. * **Collaborate Easily** – Provide developers, architects, and product managers a shared visual reference. We have more planned with the visual resource map, so stay tuned to our product map. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # FAQs
Is there any performance loss with Appear? As we only report on schemas the first time they're seen, or when they change, our impact to performance is miniscule. There is no noticable effect for users. Appear uses rate sampling to minimise the amount of data sent to your network, ensuring that performance remains optimised. If necessary, further optimisations, such as processing on a separate thread, can be implemented in the future.
How does Appear handle sensitive data? Appear is designed to prioritise your data security. Our introspector does not transfer any sensitive data (Personally Identifiable Information) out of your network. Instead, we only process and send structural information to our servers. You can audit the introspector code anytime to verify this practice, ensuring a lower barrier to entry and quicker problem-solving.
How do I manage environments in Appear? Appear automatically detects the environments set from your CI/CD pipeline variables. This makes it easy for you to ensure services from development to production are available to you within Appear.
How does Appear capture endpoints that aren't being hit? Appear won't detect endpoints not being used by systems and users. You will need to upload the associated OpenAPI spec in order for these services to be available in Appear.
Does Appear handle API versions? Yes, Appear can capture the version of your APIs and present these within the Catalog explorer. We have a method of catering for this, but it's best to discuss with us how you're using versioning to ensure we're capturing them in the right way.
How does Appear generate the API Reference and Catalog? Our open-source introspector, once installed and integrated into your system, provides detailed reports on the schema of active endpoints. These reports are processed by an LLM middleware processor, allowing us to fine-tune which AI models and
Can I test Appear locally? You can install and integrate the introspector package and run your dev environment locally. Once the server is up and running, you can mimic user behaviour to fire the endpoints and see your dev environment in Appear populate with services.
How do I know if the Appear agent is reporting? After you integrate Appear (following our [installation guide](/getting-started/installation)) you may wonder if the agent is connected and reporting OK. This can be determined in two primary ways: 1. Your Appear platform account is populating with services and data, and 2. Determining connection status in the 'Connections' page via the menu or by grouping your services by Connection Status
*** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Product Map Appear has big plans to reimagine how APIs are managed. Below is a product map that shows Appear's vision. Click on the image to browse Appear's themed set of features and their relationships. We work closely with customers to understand their specific challenges and ecosystem, meaning we can be fluid with our roadmap, which nests within this product map below.

Appear's product map which outlines the scope of our vision, grouped into themes and ordered in terms of loose dependency.

{% embed url="" %} Direct link to the product map at appear.sh {% endembed %} *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us. # Open-source The Appear team all contributes to the open-source community. When building ancillary tooling for our core product, providing it as open-source is a key consideration. We want to give back to the engineering community and foster a community around us, especially in the API uplift space. *** ### Introspection libraries Appear is designed with PII safety in mind, ensuring no sensitive data leaves your network. Our introspection libraries are all open-source and auditable, giving your security and privacy teams the confidence that working with Appear does not add risk or surface area to your privacy concerns. #### JS/TS library *** ### Components Product development is about making constant tradeoffs. However, we love building tools and components that add value to our core product and can lower the barrier to our community's engagement with us and benefit from our passion. We love the open-source community, and the API ecosystem is founded on it. We have to give back and help others trying to improve their patch. #### OpenAPI spec validator using Zod Zod is a TypeScript schema validation library for defining, validating, and transforming data structures. This tool has been created to support the type and schema validation for the detected and uploaded services within Appear, but it is available in our npm registry for you to install or use directly in the CLI. Additionally, you can clone or contribute to the project and help improve it! *** ### Tools Appear enjoys building tools to improve the developer experience for APIs. While the bulk of our work is within the Appear app, some ideas create spin-offs which we can offer for free and even open-source. #### API Validator {% hint style="success" %} The API Validator is available for you to use in our API Toolkit - [validator.appear.sh](https://www.validate.appear.sh) {% endhint %} The API Validator was created to accelerate the testing cycles for our OAS Zod Validator. We wanted to compare reports from our library with other libraries out there. In doing so, we created a simple little tool which we felt had some value to offer the community. The blended and line-mapped reports allow for quick assessment of your OpenAPI 3.x-3.1 spec's health and performance. *** If you have any queries or require support with the above instructions, please [get in touch](/getting-started/get-in-touch) with us.