> ## Documentation Index > Fetch the complete documentation index at: https://www.seam.co/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get Manufacturer Content > Returns everything Seam publishes about one manufacturer in one call: the profile (name, description, links, logos), its published device models in the summary shape with capabilities per provider, the providers that cover the brand with their integration support levels, and the live partner apps that support it in each device category (declared-first, like `/compatibility`). With a manufacturer key (secret or embed), the manufacturer is implied and `manufacturer_slug` is optional; naming another manufacturer fails with 403 `manufacturer_mismatch`. Without one, name the manufacturer with `manufacturer_slug`. Device models hidden from third parties are excluded; with the manufacturer's secret key, `include_forbidden` adds them. Device models are paged by slug with `limit` and `page_cursor`; every other field is the same on every page. Use this endpoint to read your whole brand in one call: * **`manufacturer`**: your profile, with name, description, website, support contacts, and logos. * **`device_models`**: your published device models, with images, variants, device type, providers, and capabilities per provider, in the [device model summary](/docs/device-manufacturer-guidance/manufacturer-api/device-model-summaries) shape. * **`providers`**: the providers (cloud services and systems) that connect your devices to Seam, with the support level of each integration. * **`compatibility`**: for each device category you make, the apps that support your devices through Seam, the same apps that [Compatible Apps](/docs/ui-components/overview/ecosystem-components/compatible-apps) shows. Only `device_models` is paged. Every other field is the same on every page, so you can read them from the first page. ```bash With a manufacturer secret key theme={"dark"} curl --compressed \ -H "Authorization: Bearer eco_sk_your_secret_key" \ "https://ecosystem.seam.co/v1/manufacturer_content/get" ``` ```bash Without a key theme={"dark"} curl --compressed -G \ "https://ecosystem.seam.co/v1/manufacturer_content/get" \ -d manufacturer_slug=schlage \ -d locale=fr \ -d limit=100 ``` ```json 200 (trimmed) theme={"dark"} { "manufacturer_content": { "manufacturer": { "manufacturer_id": "ef6bd59f-19aa-415a-8d12-9684eb227d8a", "slug": "schlage", "display_name": "Schlage", "website": "https://www.schlage.com", "description_md": "…", "logos": [ { "kind": "square_logo", "url": "https://seam-ecosystem-media.fly.storage.tigris.dev/…/square_logo.png", "mime": "image/png", "width": 512, "height": 512 } ], "device_model_count": 17 }, "providers": [ { "slug": "schlage", "display_name": "Schlage Home", "integrations": [ { "kind": "access", "feature": "lock_unlock", "integration_support_level": "stable", "flags": { "can_remotely_lock": true, "can_remotely_unlock": true } } ], "device_model_count": 3 } ], "compatibility": [ { "device_category": "smartlock", "partners": [ { "slug": "example-app", "display_name": "Example App", "website": "https://www.example.com", "industries": [ { "slug": "short-term-rental", "display_name": "Short-Term Rental" } ], "support": { "supported": true, "resolved_level": "manufacturer", "declared_status": "enabled", "note": null } } ] } ], "device_models": [ { "slug": "camelot-trim-connected-keypad-deadbolt", "display_name": "Camelot Trim Connected Keypad Deadbolt", "product_url": "https://www.schlage.com/en/home/products/BE369NXCAMFFF.html", "device_type": { "slug": "smartlock", "display_name": "Smartlock" }, "featured_image": { "url": "https://seam-ecosystem-media.fly.storage.tigris.dev/…" }, "variants": [ { "color_name": "Satin Nickel", "style_name": "Camelot Trim", "manufacturer_model_id": "BE369NX CAM 619", "images": [] } ], "providers": [ { "slug": "schlage-engage", "display_name": "Schlage Engage" } ], "capabilities_by_provider": [ { "provider": { "slug": "schlage-engage", "display_name": "Schlage Engage" }, "capabilities": [ { "name": "can_remotely_unlock", "supported": "yes", "integration_support_level": "stable", "report": null } ] } ] } ], "pagination": { "has_next_page": true, "next_page_cursor": "camelot-trim-connected-keypad-deadbolt" }, "locale": "en" }, "ok": true } ``` ## Errors Besides the [errors every endpoint can return](/docs/device-manufacturer-guidance/manufacturer-api/index#errors), this endpoint returns: | Status | `error.type` | Cause | | - | - | - | | 400 | `manufacturer_slug_required` | No `manufacturer_slug`, and the key (if any) is not a manufacturer key. | | 403 | `manufacturer_mismatch` | Your manufacturer key named a different manufacturer. | | 404 | `manufacturer_not_found` | No published manufacturer has this slug. | ## Next Steps * Filter device models by type, provider, or capability with [List Device Model Summaries](/docs/device-manufacturer-guidance/manufacturer-api/device-model-summaries). * Get your keys in [Keys and Authentication](/docs/device-manufacturer-guidance/manufacturer-api/keys). ## OpenAPI ````yaml device-manufacturer-guidance/manufacturer-api/openapi.json GET /manufacturer_content/get openapi: 3.1.0 info: title: Seam Ecosystem API version: 1.0.0 description: >- Read what Seam publishes about the devices it supports: manufacturers, device models with their images, variants and capabilities, the providers that integrate them, and the partner apps that support them through Seam. Every endpoint accepts `GET` with query parameters, or `POST` with the same parameters as a JSON body. Successful responses include `"ok": true`. Published content is public, so you can call most endpoints without a key. Send an embed key from a browser, or a secret key from your servers, to identify yourself. servers: - url: https://ecosystem.seam.co/v1 security: [] externalDocs: description: Manufacturer API guide url: https://www.seam.co/docs/device-manufacturer-guidance/manufacturer-api paths: /manufacturer_content/get: get: tags: - manufacturers summary: Get a manufacturer's content description: >- Returns everything Seam publishes about one manufacturer in one call: the profile (name, description, links, logos), its published device models in the summary shape with capabilities per provider, the providers that cover the brand with their integration support levels, and the live partner apps that support it in each device category (declared-first, like `/compatibility`). With a manufacturer key (secret or embed), the manufacturer is implied and `manufacturer_slug` is optional; naming another manufacturer fails with 403 `manufacturer_mismatch`. Without one, name the manufacturer with `manufacturer_slug`. Device models hidden from third parties are excluded; with the manufacturer's secret key, `include_forbidden` adds them. Device models are paged by slug with `limit` and `page_cursor`; every other field is the same on every page. parameters: - name: manufacturer_slug in: query required: false schema: description: >- Manufacturer slug. Optional with a manufacturer key, which implies its own; required otherwise. type: string - name: locale in: query required: false schema: description: >- Locale for resolved capability report text; unknown locales fall back to the default locale. type: string - name: include in: query required: false schema: description: >- Optional device model data to add: `commerce` adds marketplace and shop listings, ASINs and GTINs. type: array items: type: string enum: - commerce - name: include_forbidden in: query required: false schema: description: >- Include models forbidden to third parties (`is_forbidden_to_3dparty`): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false. anyOf: - type: boolean - type: string enum: - 'true' - 'false' - name: limit in: query required: false schema: default: 500 description: Maximum number of device models to return (1-500). type: integer minimum: 1 maximum: 500 - name: page_cursor in: query required: false schema: description: The `pagination.next_page_cursor` from the previous page. type: string responses: '200': description: OK content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: manufacturer_content: type: object properties: manufacturer: type: object properties: manufacturer_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the manufacturer. slug: type: string description: Stable identifier, e.g. `schlage`. display_name: description: Display name. type: - string - 'null' website: description: Website URL, when recorded. type: - string - 'null' headquarters: description: Headquarters location, when recorded. type: - string - 'null' country_of_origin: description: Country of origin, when recorded. type: - string - 'null' parent_org: description: >- Parent organization or brand the manufacturer is sold under. type: - string - 'null' inc_date: description: >- Incorporation year as recorded in the source, not a date. type: - string - 'null' customer_support_phone: description: Customer support phone, when recorded. type: - string - 'null' customer_support_email: description: Customer support email, when recorded. type: - string - 'null' customer_support_url: description: Customer support URL, when recorded. type: - string - 'null' description_md: description: Description in markdown, when recorded. type: - string - 'null' seam_api_guide: description: Seam API guide reference, when recorded. type: - string - 'null' commerce_footprint: anyOf: - ed6c9c96-6bf4-4454-98d6-46cf198e34fa - type: 'null' description: >- Commerce footprint verbatim from the source; null where the source holds none. last_commerce_search_at: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' description: >- When commerce listings were last searched; null is a recorded fact, not an omission. logos: type: array items: type: object properties: asset_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the asset. kind: type: string enum: - square_logo - square_logo_mono - horizontal_logo - horizontal_logo_mono - default_device_image - featured - variant_image description: >- Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image. object_key: type: string description: Immutable object-storage key. url: type: string description: Public URL of the original image. mime: description: Media type, when known. type: - string - 'null' width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. bytes: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Size in bytes, when known. sha256: description: >- SHA-256 of the original bytes, when recorded. type: - string - 'null' sort_order: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Ordering within the owning version's assets. formats: type: object propertyNames: type: string enum: - thumbnail - small - medium - large additionalProperties: type: object properties: object_key: type: string description: >- Immutable object-storage key of this format. url: type: string description: Public URL of this format. mime: description: Media type, when known. type: - string - 'null' width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. bytes: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Size in bytes, when known. sha256: description: >- SHA-256 of this format's bytes, when recorded. type: - string - 'null' required: - object_key - url - mime - width - height - bytes - sha256 additionalProperties: false description: >- Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos). created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Creation time (ISO 8601). updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Last update time (ISO 8601). required: - asset_id - kind - object_key - url - mime - width - height - bytes - sha256 - sort_order - formats - created_at - updated_at additionalProperties: false description: >- Square and horizontal logos in color and monochrome variants. default_device_images: type: array items: type: object properties: device_type: type: object properties: device_type_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the device type. slug: type: string description: Stable identifier, e.g. `smartlock`. display_name: type: string description: Display name. is_accessory: type: boolean description: >- Accessory types (bridges, keypads) rather than primary devices. required: - device_type_id - slug - display_name - is_accessory additionalProperties: false description: Device type this fallback image applies to. asset: type: object properties: asset_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the asset. kind: type: string enum: - square_logo - square_logo_mono - horizontal_logo - horizontal_logo_mono - default_device_image - featured - variant_image description: >- Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image. object_key: type: string description: Immutable object-storage key. url: type: string description: Public URL of the original image. mime: description: Media type, when known. type: - string - 'null' width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. bytes: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Size in bytes, when known. sha256: description: >- SHA-256 of the original bytes, when recorded. type: - string - 'null' sort_order: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Ordering within the owning version's assets. formats: type: object propertyNames: type: string enum: - thumbnail - small - medium - large additionalProperties: type: object properties: object_key: type: string description: >- Immutable object-storage key of this format. url: type: string description: Public URL of this format. mime: description: Media type, when known. type: - string - 'null' width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. bytes: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Size in bytes, when known. sha256: description: >- SHA-256 of this format's bytes, when recorded. type: - string - 'null' required: - object_key - url - mime - width - height - bytes - sha256 additionalProperties: false description: >- Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos). created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Creation time (ISO 8601). updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Last update time (ISO 8601). required: - asset_id - kind - object_key - url - mime - width - height - bytes - sha256 - sort_order - formats - created_at - updated_at additionalProperties: false description: Fallback image asset for that device type. required: - device_type - asset additionalProperties: false description: Fallback device image per device type. providers: type: array items: type: object properties: provider_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the provider. slug: type: string description: Stable identifier, e.g. `salto-ks`. display_name: description: Display name. type: - string - 'null' required: - provider_id - slug - display_name additionalProperties: false description: >- Providers this manufacturer's devices integrate with. device_model_count: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Number of published device models for this manufacturer that the caller may list. Models forbidden to third parties count only for Seam callers, and for a manufacturer secret key only its own. created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Creation time (ISO 8601). updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Last update time (ISO 8601). required: - manufacturer_id - slug - display_name - website - headquarters - country_of_origin - parent_org - inc_date - customer_support_phone - customer_support_email - customer_support_url - description_md - seam_api_guide - commerce_footprint - last_commerce_search_at - logos - default_device_images - providers - device_model_count - created_at - updated_at additionalProperties: false description: >- The manufacturer profile: name, description, links, logos and default device images. `device_model_count` counts the device models this caller is shown. providers: type: array items: type: object properties: provider_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the provider. slug: type: string description: Stable identifier, e.g. `salto-ks`. display_name: description: Display name. type: - string - 'null' description_md: description: Description in markdown, when recorded. type: - string - 'null' is_acs: description: >- Access control system provider; null where not established. type: - boolean - 'null' has_requirements: description: >- Whether integration requirements apply; null where not established. type: - boolean - 'null' requirements_md: description: >- Free-text integration requirements, verbatim from the source. type: - string - 'null' logos: type: array items: type: object properties: asset_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the asset. kind: type: string enum: - square_logo - square_logo_mono - horizontal_logo - horizontal_logo_mono - default_device_image - featured - variant_image description: >- Asset role: a logo kind, a manufacturer default device image, a model featured image, or a variant image. object_key: type: string description: Immutable object-storage key. url: type: string description: Public URL of the original image. mime: description: Media type, when known. type: - string - 'null' width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. bytes: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Size in bytes, when known. sha256: description: >- SHA-256 of the original bytes, when recorded. type: - string - 'null' sort_order: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Ordering within the owning version's assets. formats: type: object propertyNames: type: string enum: - thumbnail - small - medium - large additionalProperties: type: object properties: object_key: type: string description: >- Immutable object-storage key of this format. url: type: string description: Public URL of this format. mime: description: Media type, when known. type: - string - 'null' width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. bytes: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Size in bytes, when known. sha256: description: >- SHA-256 of this format's bytes, when recorded. type: - string - 'null' required: - object_key - url - mime - width - height - bytes - sha256 additionalProperties: false description: >- Derived image formats actually present in the source; an empty object means the source held none (e.g. SVG logos). created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Creation time (ISO 8601). updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Last update time (ISO 8601). required: - asset_id - kind - object_key - url - mime - width - height - bytes - sha256 - sort_order - formats - created_at - updated_at additionalProperties: false description: Square logos in color and monochrome variants. integrations: type: array items: type: object properties: provider_integration_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the integration. kind: type: string enum: - access - climate - sensor description: >- Integration kind: `access`, `climate`, or `sensor`. feature: type: string description: >- Integration feature, e.g. `lock_unlock` or `hvac`. integration_support_level: anyOf: - type: string enum: - inquire - unavailable - planned - in-progress - beta - stable - type: 'null' description: >- Support level for this feature; null where the source has none. flags: type: object propertyNames: type: string additionalProperties: type: - boolean - 'null' description: >- Per-feature capability flags exactly as authored; null means not established by research. extra_info: anyOf: - 382ab66e-3c5a-4576-a338-1ef9219a703e - type: 'null' description: >- Additional integration data verbatim from the source. required: - provider_integration_id - kind - feature - integration_support_level - flags - extra_info additionalProperties: false description: >- One entry per integration feature with its support level and flags. industries: type: array items: type: object properties: industry_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the industry. slug: type: string description: >- Stable identifier, e.g. `short-term-rental`. display_name: type: string description: Display name. short_name: description: Short display name, when set. type: - string - 'null' required: - industry_id - slug - display_name - short_name additionalProperties: false description: Industries this provider serves. created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Creation time (ISO 8601). updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Last update time (ISO 8601). device_model_count: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- How many of this manufacturer's device models the caller may see (across every page) the provider covers; 0 for a provider linked only to the manufacturer. required: - provider_id - slug - display_name - description_md - is_acs - has_requirements - requirements_md - logos - integrations - industries - created_at - updated_at - device_model_count additionalProperties: false description: >- Providers (integration paths) that cover the brand: linked to the manufacturer or to any of its device models the caller may see, with their integrations and support levels. compatibility: type: array items: type: object properties: device_category: type: string description: >- Device category, the slug of a primary device type the manufacturer has models in, e.g. `smartlock`. partners: type: array items: type: object properties: partner_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the partner. slug: type: string description: Stable identifier, e.g. `hospitable`. display_name: type: string description: Display name. website: description: Website URL, when recorded. type: - string - 'null' description_md: description: >- Markdown description written by Seam or the partner. type: - string - 'null' is_live: type: boolean description: >- The partner's Seam integration is live for its customers. is_featured: type: boolean description: Featured by Seam in partner listings. legacy_industry_featured: type: boolean description: >- Legacy per-industry featured flag; use `is_featured`. industries: type: array items: type: object properties: industry_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the industry. slug: type: string description: >- Stable identifier, e.g. `short-term-rental`. display_name: type: string description: Display name. short_name: description: Short display name, when set. type: - string - 'null' required: - industry_id - slug - display_name - short_name additionalProperties: false description: Industries the partner serves. solutions: type: array items: type: object properties: solution_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the solution. slug: type: string description: >- Stable identifier, e.g. `property-management-system`. display_name: type: string description: Display name. short_name: description: Short display name, when set. type: - string - 'null' type: type: string enum: - software - service description: '`software` or `service`.' required: - solution_id - slug - display_name - short_name - type additionalProperties: false description: >- Kinds of software or service the partner offers. assets: type: array items: type: object properties: partner_asset_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the asset. kind: type: string enum: - square_logo - square_logo_mono - horizontal_logo - horizontal_logo_mono - product_image description: Logo kind or `product_image`. url: type: string format: uri description: Public URL of the asset. mime: type: string description: Media type. width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. sort_order: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Display order within the partner. required: - partner_asset_id - kind - url - mime - width - height - sort_order additionalProperties: false description: Logos and product images in display order. created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Creation time (ISO 8601). updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Last update time (ISO 8601). support: type: object properties: supported: type: boolean description: >- Whether the partner is listed for the requested scope. resolved_level: anyOf: - type: string enum: - device_category - manufacturer - provider - capability - type: 'null' description: >- The most specific level with a declaration that decided the outcome; null when nothing is declared. declared_status: anyOf: - type: string enum: - enabled - disabled - not_via_seam - type: 'null' description: >- The deciding declaration: `enabled`, `disabled` or `not_via_seam`. observed_status: anyOf: - type: string enum: - active - trace - none - unknown - type: 'null' description: >- What the nightly usage sync observed at that scope; informational only. note: description: >- Note recorded with the deciding declaration, when any. type: - string - 'null' required: - supported - resolved_level - declared_status - observed_status - note additionalProperties: false description: >- How the support matrix resolved for this category and manufacturer, with the partner's note. required: - partner_id - slug - display_name - website - description_md - is_live - is_featured - legacy_industry_featured - industries - solutions - assets - created_at - updated_at - support additionalProperties: false description: >- Live partners that support this manufacturer's devices in this category, resolved declared-first exactly like `/compatibility`. required: - device_category - partners additionalProperties: false description: >- Compatible partners per device category the manufacturer has published primary device models in. device_models: type: array items: type: object properties: device_model_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the device model. slug: type: string description: Stable identifier, e.g. `encodeplus`. display_name: description: Display name. type: - string - 'null' description_md: description: Description in markdown, when recorded. type: - string - 'null' product_url: description: Manufacturer product page URL, when recorded. type: - string - 'null' no_longer_sold: description: >- Whether the model is no longer sold; null where not established. type: - boolean - 'null' is_forbidden_to_3dparty: description: >- Forbidden to third-party consumers; such models appear only for callers allowed to set `include_forbidden`. type: - boolean - 'null' manufacturer: anyOf: - type: object properties: manufacturer_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the manufacturer. slug: type: string description: Stable identifier, e.g. `schlage`. display_name: description: Display name. type: - string - 'null' required: - manufacturer_id - slug - display_name additionalProperties: false - type: 'null' description: Pinned published manufacturer, when set. device_type: anyOf: - type: object properties: device_type_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the device type. slug: type: string description: Stable identifier, e.g. `smartlock`. display_name: type: string description: Display name. is_accessory: type: boolean description: >- Accessory types (bridges, keypads) rather than primary devices. required: - device_type_id - slug - display_name - is_accessory additionalProperties: false - type: 'null' description: Pinned published device type, when set. device_type_properties: anyOf: - 5e0c8dac-2812-4457-bbe2-16c06145b541 - type: 'null' description: >- Per-device-type properties verbatim, including the source component discriminator; null for accessory types. featured_image: anyOf: - type: object properties: url: type: string description: Public URL of the original image. mime: description: Media type, when known. type: - string - 'null' width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. formats: type: object propertyNames: type: string enum: - thumbnail - small - medium - large additionalProperties: type: object properties: url: type: string description: Public URL of this rendition. width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. required: - url - width - height additionalProperties: false description: >- Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG). required: - url - mime - width - height - formats additionalProperties: false - type: 'null' description: >- Featured image with its renditions, when present. variants: type: array items: type: object properties: device_model_variant_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the variant. color_name: description: Variant color axis. type: - string - 'null' style_name: description: Variant style axis. type: - string - 'null' primary_color_hex: description: >- Primary color as a hex value, when recorded. type: - string - 'null' manufacturer_model_id: description: >- Manufacturer's own model identifier, when recorded. type: - string - 'null' images: type: array items: type: object properties: url: type: string description: Public URL of the original image. mime: description: Media type, when known. type: - string - 'null' width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. formats: type: object propertyNames: type: string enum: - thumbnail - small - medium - large additionalProperties: type: object properties: url: type: string description: Public URL of this rendition. width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Width in pixels, when known. height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Height in pixels, when known. required: - url - width - height additionalProperties: false description: >- Smaller renditions present for this image, keyed `thumbnail`, `small`, `medium`, `large`; empty when there are none (e.g. SVG). required: - url - mime - width - height - formats additionalProperties: false description: Images of this variant. asin: description: >- Amazon ASIN, when recorded. Only with `include=commerce`. type: - string - 'null' gtins: description: >- GTIN values verbatim from the source. Only with `include=commerce`. anyOf: - c9980870-9583-4da0-8d4a-288d6ef2d393 - type: 'null' marketplace_listings: description: >- Marketplace listing data verbatim from the source. Only with `include=commerce`. anyOf: - d412d947-cfa2-49ad-9463-1f447ed3ab08 - type: 'null' required: - device_model_variant_id - color_name - style_name - primary_color_hex - manufacturer_model_id - images additionalProperties: false description: Variants in source order, each with its images. providers: type: array items: type: object properties: provider_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the provider. slug: type: string description: Stable identifier, e.g. `salto-ks`. display_name: description: Display name. type: - string - 'null' required: - provider_id - slug - display_name additionalProperties: false description: >- Providers that can create accesses on this model. capabilities_by_provider: type: array items: type: object properties: provider: type: object properties: provider_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Ecosystem UUID of the provider. slug: type: string description: Stable identifier, e.g. `salto-ks`. display_name: description: Display name. type: - string - 'null' required: - provider_id - slug - display_name additionalProperties: false description: Provider the capabilities belong to. capabilities: type: array items: type: object properties: name: type: string enum: - device_connectivity - can_program_online_access_codes - can_program_offline_access_codes - can_remotely_unlock - can_remotely_lock - can_encode_plastic_cards - can_provision_mobile_keys - can_provision_wallet_keys - can_hvac_cool - can_hvac_heat - can_hvac_auto - can_hvac_fan - can_program_thermostat_weekly_programs - can_monitor description: Capability name. supported: type: string enum: - 'yes' - 'no' - conditionally description: >- Computed support: `yes`, `no`, or `conditionally`. integration_support_level: anyOf: - type: string enum: - inquire - unavailable - planned - in-progress - beta - stable - type: 'null' description: >- Support level of the provider integration behind this capability; null where the source has none. report: anyOf: - type: object properties: details: type: string description: >- Report detail text, or a translation dictionary key in `report_raw`. requirements: description: Requirements keyed by requirement name. type: object propertyNames: type: string additionalProperties: type: object properties: message: type: string description: >- Requirement message, or a translation dictionary key in `report_raw`. device_slugs: description: >- Device model slugs satisfying this requirement. type: array items: type: string required: - message additionalProperties: {} dependencies: description: Capability names this report depends on. type: array items: type: string required: - details additionalProperties: {} - type: 'null' description: >- Report with `details` and requirement messages resolved for the requested `locale`; null when none is stored. required: - name - supported - integration_support_level - report additionalProperties: false description: Computed capabilities for that provider. required: - provider - capabilities additionalProperties: false description: >- Currently published computed capabilities grouped by provider; stale scopes are omitted. capabilities_stale: type: boolean description: >- True when some provider scope's capabilities are omitted until they are recomputed. shop_listings: description: >- Commerce listing data verbatim from the source. Only with `include=commerce`. anyOf: - 646e72e1-c2cf-4274-bbb6-8727fa64156e - type: 'null' last_commerce_search_at: description: >- When commerce listings were last searched. Only with `include=commerce`. anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ description: Last update time (ISO 8601). required: - device_model_id - slug - display_name - description_md - product_url - no_longer_sold - is_forbidden_to_3dparty - manufacturer - device_type - device_type_properties - featured_image - variants - providers - capabilities_by_provider - capabilities_stale - updated_at additionalProperties: false description: >- Published device models, ordered by slug, in the slim summary shape. pagination: type: object properties: has_next_page: type: boolean description: Whether another page of device models follows. next_page_cursor: description: >- Pass as `page_cursor` for the next page of device models; null on the last page. type: - string - 'null' required: - has_next_page - next_page_cursor additionalProperties: false description: >- Pagination of `device_models`; every other field is the same on every page. locale: type: string description: >- The locale capability reports were resolved in, after fallback. required: - manufacturer - providers - compatibility - device_models - pagination - locale additionalProperties: false description: The manufacturer's published content. ok: type: boolean const: true description: Always `true` on success. required: - manufacturer_content - ok additionalProperties: false $defs: __schema0: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema0 - type: object propertyNames: type: string additionalProperties: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema0 __schema1: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema1 - type: object propertyNames: type: string additionalProperties: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema1 __schema2: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema2 - type: object propertyNames: type: string additionalProperties: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema2 __schema3: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema3 - type: object propertyNames: type: string additionalProperties: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema3 __schema4: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema4 - type: object propertyNames: type: string additionalProperties: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema4 __schema5: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema5 - type: object propertyNames: type: string additionalProperties: $ref: >- #/paths/~1manufacturer_content~1get/get/responses/200/content/application~1json/schema/$defs/__schema5 '400': description: Invalid parameters content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: ok: type: boolean const: false description: Always `false` on error. error: type: object properties: type: type: string description: Machine-readable error type. message: type: string description: Human-readable error message. request_id: type: string description: Request ID to include when you contact Seam. data: description: >- Details for some error types, such as validation issues. type: object propertyNames: type: string additionalProperties: {} required: - type - message - request_id additionalProperties: false required: - ok - error additionalProperties: false '401': description: The key is unknown, revoked or unsupported content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: ok: type: boolean const: false description: Always `false` on error. error: type: object properties: type: type: string description: Machine-readable error type. message: type: string description: Human-readable error message. request_id: type: string description: Request ID to include when you contact Seam. data: description: >- Details for some error types, such as validation issues. type: object propertyNames: type: string additionalProperties: {} required: - type - message - request_id additionalProperties: false required: - ok - error additionalProperties: false '403': description: >- The key does not allow this request, such as an origin that is not allowed content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: ok: type: boolean const: false description: Always `false` on error. error: type: object properties: type: type: string description: Machine-readable error type. message: type: string description: Human-readable error message. request_id: type: string description: Request ID to include when you contact Seam. data: description: >- Details for some error types, such as validation issues. type: object propertyNames: type: string additionalProperties: {} required: - type - message - request_id additionalProperties: false required: - ok - error additionalProperties: false '429': description: Rate limited content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: ok: type: boolean const: false description: Always `false` on error. error: type: object properties: type: type: string description: Machine-readable error type. message: type: string description: Human-readable error message. request_id: type: string description: Request ID to include when you contact Seam. data: description: >- Details for some error types, such as validation issues. type: object propertyNames: type: string additionalProperties: {} required: - type - message - request_id additionalProperties: false required: - ok - error additionalProperties: false headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer security: - {} - secret_key: [] - embed_key: [] - embed_key_param: [] components: securitySchemes: secret_key: type: http scheme: bearer bearerFormat: eco_sk_… description: >- Optional on endpoints that serve published content. A secret key (`eco_sk_…`), sent as `Authorization: Bearer eco_sk_…` from your servers only. A manufacturer secret key implies its manufacturer and can include that manufacturer's device models hidden from third parties. embed_key: type: apiKey in: header name: X-Embed-Key description: >- An embed key (`eco_live_…`) for browser requests; the request's `Origin` must match one of the key's allowed origins. Optional on most endpoints, but `embed/resolve` always needs one, and so does `compatibility` from a browser on a site other than seam.co. A manufacturer embed key implies its manufacturer. embed_key_param: type: apiKey in: query name: embed_key description: >- An embed key sent as the `embed_key` query parameter instead of the `X-Embed-Key` header. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.