# Resources ## List Resources > List all Resources items.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources":{"get":{"summary":"List Resources","description":"List all Resources items.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"list-resources","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Resources","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Resources collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Resource > Create a new Resource item.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources":{"post":{"summary":"Create Resource","description":"Create a new Resource item.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"create-resource","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"}],"requestBody":{"description":"Payload to create a new Resource item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"responses":{"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Resource > Get a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources/{id}":{"get":{"summary":"Get Resource","description":"Get a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"get-resource-by-id","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Resource details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Resource > Completely replaces a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources/{id}":{"post":{"summary":"Replace Resource","description":"Completely replaces a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"replace-resource-by-id","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Resource item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"responses":{"200":{"description":"Resource replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Resource > Delete a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources/{id}":{"delete":{"summary":"Delete Resource","description":"Delete a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"delete-resource-by-id","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Resource deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Resource > Partially updates a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"versionId":{"schema":{"$ref":"#/components/schemas/versionId"},"required":true,"description":"Catalog version identifier","in":"path","name":"versionId"}},"schemas":{"versionId":{"type":"string","minLength":30,"maxLength":30,"description":"Catalog version identifier"},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/versions/{versionId}/resources/{id}":{"patch":{"summary":"Update Resource","description":"Partially updates a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"update-resource-by-id","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/versionId"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Resource item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agpf42ylcfymdjwxhwzljgj7va","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"}}}}}},"responses":{"200":{"description":"Resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## List Resources > List all Resources items.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."},"PaginationMetadata":{"type":"object","properties":{"nextCursor":{"type":["string","null"]},"hasMore":{"type":"boolean"},"limit":{"type":"number"}},"required":["nextCursor","hasMore","limit"],"description":"Pagination metadata"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources":{"get":{"summary":"List Resources","description":"List all Resources items.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"list-resources1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","description":"Cursor for pagination (item ID)"},"required":false,"description":"Cursor for pagination (item ID)","name":"after","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000,"default":50,"description":"Maximum number of items to return (default: 50, max: 1000)"},"required":false,"description":"Maximum number of items to return (default: 50, max: 1000)","name":"limit","in":"query"},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)"},"required":false,"description":"Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)","name":"sort","in":"query"}],"responses":{"200":{"description":"List of Resources","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Resource"}},"pagination":{"$ref":"#/components/schemas/PaginationMetadata"}},"required":["items","pagination"],"description":"Resources collection"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Create Resource > Create a new Resource item.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ConflictError":{"description":"Conflict","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources":{"post":{"summary":"Create Resource","description":"Create a new Resource item.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"create-resource1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"}],"requestBody":{"description":"Payload to create a new Resource item","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"responses":{"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"$ref":"#/components/responses/ConflictError"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Get Resource > Get a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources/{id}":{"get":{"summary":"Get Resource","description":"Get a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"get-resource-by-id1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"responses":{"200":{"description":"Resource details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Replace Resource > Completely replaces a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources/{id}":{"post":{"summary":"Replace Resource","description":"Completely replaces a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"replace-resource-by-id1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"requestBody":{"description":"Payload to replace the Resource item by its id","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"responses":{"200":{"description":"Resource replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"201":{"description":"Resource created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Delete Resource > Delete a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources/{id}":{"delete":{"summary":"Delete Resource","description":"Delete a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"delete-resource-by-id1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"responses":{"204":{"description":"Resource deleted"},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` ## Update Resource > Partially updates a Resource item by its id.\ > \ > Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema. ```json {"openapi":"3.1.0","info":{"title":"Appear API","version":"2.0.0"},"tags":[{"name":"Resources"}],"servers":[{"url":"https://api.appear.sh","description":"Primary public endpoint"}],"security":[{"projectApiKey":[]},{"personalAccessToken":[]}],"components":{"securitySchemes":{"projectApiKey":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Project API key authentication. Use your project API key as a Bearer token in the Authorization header."},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal access token authentication. Use your personal access token as a Bearer token in the Authorization header. Suitable for MCP integrations, CLI tools, and other OAuth flows."}},"parameters":{"projectRef":{"schema":{"$ref":"#/components/schemas/projectRef"},"required":true,"description":"Project slug or project id (proj_*)","in":"path","name":"projectRef"},"versionType":{"schema":{"$ref":"#/components/schemas/versionType"},"required":true,"description":"Version type, can be either 'branch' or 'environment'","in":"path","name":"versionType"},"versionSlug":{"schema":{"$ref":"#/components/schemas/versionSlug"},"required":true,"description":"Version slug","in":"path","name":"versionSlug"}},"schemas":{"projectRef":{"anyOf":[{"type":"string","minLength":31,"maxLength":31,"description":"Object ID with prefix \"proj_\""},{"type":"string","minLength":1}],"description":"Project slug or project id (proj_*)"},"versionType":{"type":"string","enum":["branch","environment"],"description":"Version type, can be either 'branch' or 'environment'"},"versionSlug":{"type":"string","minLength":1,"description":"Version slug"},"AnyJsonSchema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"required":{"type":"array","items":{"type":"string"}},"default":{"type":"object","properties":{},"additionalProperties":{}},"enum":{"type":"array","items":{"type":"object","properties":{},"additionalProperties":{}}},"const":{"type":"object","properties":{},"additionalProperties":{}},"patternProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"additionalProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"unevaluatedProperties":{"anyOf":[{"type":"boolean","enum":[false]},{"$ref":"#/components/schemas/AnyJsonSchema"}]},"propertyNames":{"$ref":"#/components/schemas/AnyJsonSchema"},"minProperties":{"type":"number"},"maxProperties":{"type":"number"},"dependentRequired":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"dependentSchemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"dependencies":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"array","items":{"type":"string"}}]}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["array"]},"items":{"$ref":"#/components/schemas/AnyJsonSchema"},"unevaluatedItems":{"anyOf":[{"$ref":"#/components/schemas/AnyJsonSchema"},{"type":"boolean","enum":[false]}]},"default":{"type":"array","items":{}},"enum":{"type":"array","items":{"type":"array","items":{}}},"const":{"type":"array","items":{}},"contains":{"$ref":"#/components/schemas/AnyJsonSchema"},"minContains":{"type":"number"},"maxContains":{"type":"number"},"minItems":{"type":"number"},"maxItems":{"type":"number"},"uniqueItems":{"type":"boolean","enum":[true]},"prefixItems":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["number"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["integer"]},"default":{"type":"number"},"enum":{"type":"array","items":{"type":"number"}},"const":{"type":"number"},"minimum":{"type":"number"},"maximum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"exclusiveMaximum":{"type":"boolean"},"multipleOf":{"type":"number"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["string"]},"default":{"type":"string"},"enum":{"type":"array","items":{"type":"string"}},"const":{"type":"string"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"pattern":{"type":"string"},"format":{"type":"string"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["boolean"]},"default":{"type":"boolean"},"enum":{"type":"array","items":{"type":"boolean"}},"const":{"type":"boolean"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"type":{"type":"string","enum":["null"]},"default":{"type":"null"},"enum":{"type":"array","items":{"type":"null"}},"const":{"type":"null"}},"required":["type"]},{"type":"object","properties":{"$schema":{"type":"string"},"$id":{"type":"string"},"$ref":{"type":"string"},"$comment":{"type":"string"},"$defs":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnyJsonSchema"}},"$vocabulary":{"type":"object","additionalProperties":{"type":"boolean"}},"$dynamicRef":{"type":"string"},"$dynamicAnchor":{"type":"string"},"$anchor":{"type":"string"},"if":{"$ref":"#/components/schemas/AnyJsonSchema"},"then":{"$ref":"#/components/schemas/AnyJsonSchema"},"else":{"$ref":"#/components/schemas/AnyJsonSchema"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/AnyJsonSchema"}},"not":{"$ref":"#/components/schemas/AnyJsonSchema"},"title":{"type":"string"},"description":{"type":"string"},"deprecated":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"}}}],"description":"JSON Schema for any data type."},"Resource":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_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."}},"responses":{"BadRequestError":{"description":"Invalid request","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"NotFoundErrorResource":{"description":"Resource not found","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"string"},"details":{}},"required":["error"],"additionalProperties":false}}}}}},"paths":{"/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/resources/{id}":{"patch":{"summary":"Update Resource","description":"Partially updates a Resource item by its id.\n\nResource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.","operationId":"update-resource-by-id1","tags":["Resources"],"parameters":[{"$ref":"#/components/parameters/projectRef"},{"$ref":"#/components/parameters/versionType"},{"$ref":"#/components/parameters/versionSlug"},{"schema":{"type":"string","minLength":30,"maxLength":30,"description":"Resource identifier"},"required":true,"description":"Resource identifier","name":"id","in":"path"}],"requestBody":{"description":"Partial payload to update the Resource item by its id","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":30,"maxLength":30,"default":"rsc_agpf42ylcfymdjwxizqgkcmvpq","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"}}}}}},"responses":{"200":{"description":"Resource updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Resource"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundErrorResource"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}} ``` --- # 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/resources.md?ask= ``` 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.