# 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_agpf42ylcfymdjwxdxp7pamfmq","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-05-25T09:15:34.033Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-05-25T09:15:34.033Z"},"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_agpf42ylcfymdjwxg5qyrna2qq","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-05-25T09:15:34.033Z"},"updatedAt":{"type":["string","null"],"format":"date-time","default":"2026-05-25T09:15:34.033Z"}},"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_agpf42ylcfymdjwxjzg64m3hoy","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-05-25T09:15:34.033Z"}},"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_agpf42ylcfymdjwxmq5svx3e4m","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-05-25T09:15:34.033Z"}},"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_agpf42ylcfymdjwxpymbbspfby","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-05-25T09:15:34.033Z"}},"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_agpf42ylcfymdjwxsuxvwi2fim","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-05-25T09:15:34.033Z"}},"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_agpf42ylcfymdjwxv55hg5pfgm","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-05-25T09:15:34.033Z"}},"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_agpf42ylcfymdjwxy6nsjmtxky","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-05-25T09:15:34.033Z"}},"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_agpf42ylcfymdjwx36gzhd55mm","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-05-25T09:15:34.033Z"}},"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_agpf42ylcfymdjwx6snjks4rwi","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-05-25T09:15:34.033Z"},"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_agpf42ylcfymdjwyb6olnrujoe","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-05-25T09:15:34.033Z"}},"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"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.appear.sh/api/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.