canonical: https://jentic.com/apis/aryeo.com/aryeo

# Aryeo API

Jentic publishes the only available OpenAPI specification for Aryeo API, keeping it validated and agent-ready. Aryeo is a real estate media management platform that connects photographers, agents, and brokerages to manage listings, media deliverables, and shoot orders. The API exposes 7 read and order-management endpoints covering listings, orders, and appointments, secured with bearer token authentication. It is designed for partners who need programmatic access to listing media and shoot scheduling rather than full storefront management.

## For AI agents

Read real estate listings, place media-shoot orders, and look up appointments in the Aryeo real estate media platform.

## Scope

Does not handle MLS submission, e-signature, or payment collection - use for real estate media order creation, listing reads, and appointment lookups only.

## Capabilities

- Retrieve a paginated list of real estate listings with associated media
- Place a new media-shoot order against a listing
- Look up the status of a placed media order by order ID
- Pull appointment details for scheduled property shoots
- Fetch a single listing by ID for downstream workflows

## Use cases

### Listing-to-Shoot Automation

When a new property is added to a brokerage's CRM, automatically create the corresponding media-shoot order in Aryeo. The /orders endpoints accept an order tied to an existing listing, removing the manual handoff between agents and the media coordination team. Suitable for brokerages running 50+ listings per week.

Example prompt: Create a new order in Aryeo for listing ID 'abc123' for a standard photo and 3D tour package and return the order ID

### Appointment Confirmation Workflow

Pull upcoming media appointments from Aryeo and surface them in agent calendars or chat tools. The /appointments endpoints return scheduled shoots so an agent can confirm timing with the homeowner, send reminders, and update the brokerage's operations dashboard. Useful where photographers and listing agents coordinate across multiple platforms.

Example prompt: List Aryeo appointments scheduled in the next 48 hours and produce a homeowner-confirmation message for each

### Listing Media Sync

Use the /listings endpoints to keep external systems - websites, CRMs, MLS feeds - synchronised with Aryeo's listing records and media references. Agents can poll listings for changes and trigger downstream publishing flows whenever new photography or 3D tours are delivered.

Example prompt: Fetch all Aryeo listings updated in the last 24 hours and publish their media URLs to a brokerage CMS

### AI Agent for Real Estate Media Operations

An agent integrated through Jentic can monitor new listings, automatically place shoot orders, and confirm appointment changes - coordinating photographers, agents, and homeowners without bespoke integration code. Jentic isolates the Aryeo bearer token in the credential vault so the agent never holds raw secrets.

Example prompt: Through Jentic, watch for new brokerage listings and place corresponding Aryeo orders, then confirm each appointment with the listing agent

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /listings | List listings |
| GET | /listings/{listing_id} | Get listing |
| POST | /orders | Create order |
| GET | /orders | List orders |
| GET | /orders/{order_id} | Get order |
| GET | /appointments | List appointments |
| GET | /appointments/{appointment_id} | Get appointment |

## Key resources

- **Listings** — Read real estate listings with attached media references
- **Orders** — Create and read media-shoot orders against listings
- **Appointments** — Look up scheduled shoot appointments

## Why Jentic

- **Setup:** Wiring Aryeo by hand means handling its bearer auth for real estate listing, order, and appointment calls against its versioned host. Through Jentic you install once, import the Aryeo API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Aryeo puts the listing and order id in the URL path (/orders/{order_id}), so a rule can pin your agent to reads for one order or listing. You choose the operations it may call, so placing new media orders is not included unless you add it.
- **Credential handling:** Your Aryeo bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'place a real estate media order', and Jentic returns the POST /orders operation with its input schema so the agent calls the right endpoint without reading the Aryeo docs.

## Related APIs

- **Cloudinary Upload API** — Cloudinary stores, transforms, and delivers the property images and videos that Aryeo orders produce.
- **Mux** — Mux handles encoding and streaming of property video walkthroughs that Aryeo schedules and delivers.
- **Vimeo** — Vimeo hosts and delivers real estate video as a general-purpose video platform without Aryeo's shoot-ordering workflow.

## FAQ

### Why is there no official OpenAPI spec for Aryeo API?

Aryeo does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Aryeo 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 Aryeo API use?

The API uses HTTP bearer token authentication, passed in the Authorization header as 'Bearer {token}'. When called through Jentic, the token is stored in the Jentic credential vault and injected at execution time so it never enters the agent's context.

### Can I create a media-shoot order through the Aryeo API?

Yes. POST /orders accepts a new media-shoot order tied to an existing listing. The same endpoint set supports listing all orders and retrieving a single order by ID for status checks.

### What are the rate limits for the Aryeo API?

The OpenAPI specification does not publish explicit rate limits. Implement exponential backoff on HTTP 429 responses and cache /listings reads where freshness allows, since listing metadata changes infrequently between shoots.

### How do I place an order through Jentic?

Search Jentic for 'create a real estate media order' and the POST /orders operation will be returned. Load the operation schema, supply the listing_id and order details, and execute. Jentic handles authentication and returns the created order ID to the agent.

### Can I limit what my agent is allowed to do with the Aryeo API?

Yes. Because you run Jentic One yourself, your own rules decide which Aryeo operations and credentials the agent may use. Aryeo puts the listing and order id in the URL path, such as /orders/{order_id} and /listings/{listing_id}, so you can pin the agent to reads of a single order or listing. You choose the operations it may call, which means placing new media-shoot orders through POST /orders is excluded unless you explicitly grant it.