canonical: https://jentic.com/apis/aboutwayfair.com/wayfair

# Aboutwayfair Wayfair 3D Models API

Jentic publishes the only available OpenAPI specification for Wayfair 3D Models API, keeping it validated and agent-ready. Wayfair's 3D Models API exposes its catalogue of realtime 3D model data for products, intended for partners building AR previews, virtual room planners, and product visualisers. The three endpoints cover demo access, registered access, and a sign-up route. Authentication for registered access uses HTTP Basic with credentials issued after sign-up. The surface is intentionally narrow: it is read-only product 3D data, not a full commerce or inventory API.

## For AI agents

Fetch Wayfair 3D model data for products via Basic auth. Use it for AR previews, room planners, and product visualisation tools.

## Scope

Does not handle product purchase, inventory, pricing, or order fulfilment - use for partner access to 3D model data only.

## Capabilities

- Pull a sample set of 3D models for evaluation without an account
- Retrieve realtime 3D model data for products as a registered partner
- Submit a sign-up request to obtain registered API access

## Use cases

### AR Product Preview

Retailers and home-design apps add an AR preview that lets shoppers place a Wayfair product in their room before buying. The Wayfair 3D Models API provides the underlying model data; the demo endpoint covers prototyping while registered access supplies the production catalogue. The narrow surface keeps integration cheap when 3D is one feature inside a larger experience.

Example prompt: Pull demo 3D models, build a viewer prototype, then switch to the registered endpoint with stored credentials

### Virtual Room Planner

Room-planning tools render furniture in a 3D scene so users can lay out a room before buying. The realtime endpoint returns up-to-date 3D model data for the registered catalogue, so a planner can show current product geometry and textures rather than stale local copies. Pair with a sign-up flow to issue partner credentials.

Example prompt: Fetch realtime 3D model data for product SKU 'W12345' and render it in the planner scene

### Partner Onboarding

Wayfair partners begin with the demo endpoint to evaluate the data shape, then submit a sign-up request to receive registered credentials. POST /sign_up captures partner details and triggers the Wayfair onboarding workflow. Backend automation can drive the demo + sign-up steps before handing the production credentials to the integration team.

Example prompt: Submit a sign-up request for partner 'AcmeAR' with contact email and intended use case

### Agent-Driven Catalogue Access via Jentic

AI agents that build product visualisations on demand can call the Wayfair 3D Models API as a tool. Through Jentic, an agent searches by intent, loads the registered-access operation, and executes with the Basic credentials held in your Jentic One instance. The structured response slots into the agent's downstream rendering pipeline.

Example prompt: Search Jentic for 'fetch Wayfair 3D models', load the schema, and execute the registered-access call with credentials from the vault

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/models_demo` | Get demo 3D models without authentication |
| GET | `/models` | Get realtime 3D model data for registered partners |
| POST | `/sign_up` | Register for partner API access |

## Key resources

- **Models** — Registered partner endpoint returning realtime 3D model data
- **Models Demo** — Public demo endpoint for evaluating the response shape
- **Sign Up** — Submit a partner sign-up request to obtain registered access

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 42 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 54 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/aboutwayfair.com/wayfair/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Wayfair 3D Models API by hand means encoding its Basic auth credentials, base64-building the Authorization header, and pointing calls at the partner host yourself. Through Jentic you install once, import the Wayfair 3D Models API from the API Directory, store the Basic credentials once, and your agent calls it.
- **Permission scoping:** The models and sign-up paths carry no resource id in the URL, so limit the agent to the operations it needs, such as listing 3D models. You choose the operations it may call, so partner sign-up is not included unless you add it.
- **Credential handling:** Your Wayfair Basic auth credentials are stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'fetch Wayfair 3D models', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify Admin API** — Shopify Admin API for product catalogues and storefronts.
- **eBay Buy** — eBay's Buy API for product search and purchase context.
- **AB.GL** — URL shortener for tracking shared 3D model preview links.

## FAQ

### Why is there no official OpenAPI spec for Wayfair 3D Models API?

Wayfair publishes a partner page describing the 3D Models endpoints rather than a hosted OpenAPI catalog. Jentic generates and maintains this spec so that AI agents and developers can call Wayfair 3D Models API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Wayfair 3D Models API use?

Registered access uses HTTP Basic auth with credentials issued after a partner sign-up. The demo endpoint is reachable without credentials. Through Jentic, partner credentials are stored encrypted in your Jentic One instance and applied at execution time, so the raw Basic auth string never enters the agent's context.

### Can I fetch realtime 3D models with the Wayfair 3D Models API?

Yes. GET /models is the registered partner endpoint that returns realtime 3D model data. GET /models_demo is the unauthenticated demo endpoint useful for prototyping the response shape before registering for full access.

### How do I sign up for registered access through Jentic?

Search Jentic for 'register for Wayfair 3D Models access' to find POST /sign_up, load the schema, and execute the call with the partner contact details. Wayfair returns credentials out of band; once issued, store them in your Jentic One instance for the registered endpoint.

### What are the rate limits for the Wayfair 3D Models API?

The OpenAPI spec does not document explicit rate limits. Treat the API as low-throughput partner integration: cache responses where possible, add backoff on 429 or 5xx, and confirm production limits with the Wayfair partner contact issued at sign-up.

### What 3D model formats does the API return?

The demo and registered endpoints return realtime 3D model data formatted for visualisation use cases (AR previews, room planners). Inspect the demo response first to confirm the field shape and any URLs to model assets before building production rendering logic.

### Can I limit what my agent is allowed to do with the Wayfair 3D Models API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use, so you can allow only the calls it needs, such as GET /models to fetch registered 3D model data or GET /models_demo to prototype against the demo endpoint. The models and sign-up paths carry no resource id in the URL, so scoping happens at the operation level rather than per object. Partner registration through POST /sign_up is excluded unless you explicitly grant it, and the stored Basic auth credentials are injected at execution time rather than exposed to the agent.