Yarda Developer Platform

AI landscape design, built into your app

Generate landscape designs, retrieve satellite imagery, detect property boundaries, and estimate materials — via REST API or MCP server.

Talk to us

Quick Start

Three calls from address to finished design.

  1. 1

    Get an API key

    Create a free account, then request a key from support@yarda.ai.

    Your key starts with yarda_ak_

  2. 2

    Generate a design

    Replace yarda_ak_YOUR_KEY with your key and run:

    bash
    # 1. Get property info (satellite image + boundary)
curl -X POST https://yardav5-production.up.railway.app/api/agent/property-info \
  -H "X-API-Key: yarda_ak_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"address": "742 Evergreen Terrace, Springfield, IL"}'

# 2. Generate a landscape design
curl -X POST https://yardav5-production.up.railway.app/api/agent/designs \
  -H "X-API-Key: yarda_ak_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "742 Evergreen Terrace, Springfield, IL",
    "style": "modern_minimalist",
    "yard_area": "back"
  }'

# 3. Poll until status is "completed"
curl https://yardav5-production.up.railway.app/api/agent/designs/<design_id> \
  -H "X-API-Key: yarda_ak_YOUR_KEY"
  3. 3

    Retrieve the result

    The create call returns a design_id. Poll GET /api/agent/designs/{design_id} until status is "completed", then use the returned renders[].url in your UI.

MCP Server

Add Yarda to Claude, Codex, ChatGPT or Cursor — sign in with your Yarda account, or use an API key.

Claude.ai

Settings → Capabilities → Connectors → Add custom connector. Paste the server URL below and sign in with your Yarda account when prompted — no API key needed.

text
https://yarda-mcp-server-production.up.railway.app/mcp

Codex

Add the server, sign in with Yarda when prompted, and confirm the connection (checked against codex-cli 0.162; see the official Codex MCP guide for your version):

bash
codex mcp add yarda --url https://yarda-mcp-server-production.up.railway.app/mcp
codex mcp login yarda
codex mcp list

Claude Code

Credential-free (OAuth, recommended) — then check status with /mcp:

bash
claude mcp add --transport http --scope local yarda https://yarda-mcp-server-production.up.railway.app/mcp
claude mcp login yarda

Or with an API key:

bash
claude mcp add --transport http yarda https://yarda-mcp-server-production.up.railway.app/mcp \
  --header "Authorization: Bearer yarda_ak_YOUR_KEY"

Cursor

Add to ~/.cursor/mcp.json

json
// ~/.cursor/mcp.json
{
  "mcpServers": {
    "yarda": {
      "url": "https://yarda-mcp-server-production.up.railway.app/mcp",
      "headers": {
        "Authorization": "Bearer yarda_ak_YOUR_KEY"
      }
    }
  }
}

Other MCP clients

Any Streamable-HTTP client (ChatGPT developer mode, Grok, scripts) can use this config shape:

json
// Generic MCP client config
{
  "mcpServers": {
    "yarda": {
      "url": "https://yarda-mcp-server-production.up.railway.app/mcp",
      "headers": {
        "Authorization": "Bearer yarda_ak_YOUR_KEY"
      }
    }
  }
}

Then ask: “Design a modern minimalist landscape for 742 Evergreen Terrace, Springfield”

Assistant tools (primary)

  • find_property

    Look up a US address for free; see the property image and outline in the later review

  • list_styles

    The six design styles (public — works without signing in)

  • design_yard

    Prepare a Pro design using the property reference. If review is required, open the review link in Yarda, confirm the outline, then repeat the original request with the returned review ID and revision; design credits are not charged before confirmation.

  • get_design

    Wait for a running design and fetch its plan and 3D-view links, or open a saved design

  • list_designs

    Your most recent Pro designs, made on the web or through an assistant

  • get_account

    Your plan, remaining designs and free-trial allowance

  • subscribe

    A Yarda Pro checkout link when payment is needed

  • poll_job

    A quick one-shot job status check for apps/widgets; most models should use get_design instead

Every signed-in caller gets these eight tools with OAuth or an API key. poll_job is app/widget-facing and hidden in some clients — get_design waits for the result instead.

Compatibility tools (API key only)

  • get_property_info

    Satellite imagery + property boundary polygon for any US address

  • generate_design

    AI landscape design — 2D site plan + renders

  • get_design_status

    Poll a running design and retrieve its renders

  • list_styles

    Available design styles (Modern, Cottage, Tropical, …)

  • estimate_materials

    Material quantities and cost estimates for a design

  • get_pricing

    Plan details and per-request pricing

  • create_proposal

    Turn a design into a shareable client proposal with your markup

  • quick_design

    A fast single-image design preview

The legacy Agent-API set, exposed only to API-key callers. Prefer the assistant tools above; output and charging differ between the two generations.

MCP server URL: https://yarda-mcp-server-production.up.railway.app/mcp

API Reference

Base URL: https://yardav5-production.up.railway.app

  • POST/api/agent/property-info

    Satellite imagery + boundary polygon for a US address

  • POST/api/agent/designs

    Start an AI landscape design generation

  • GET/api/agent/designs/{id}

    Retrieve design status and render URLs

  • GET/api/agent/styles

    List available design styles

  • POST/api/agent/designs/{id}/estimate-materials

    Material quantities + cost estimate for a design

  • POST/v1/agent/proposals

    Create a shareable proposal link for a design

  • POST/api/agent/quick-design

    Fast Street View front-yard redesign

  • GET/health

    Health check — no auth required

Authentication

REST API: X-API-Key: yarda_ak_YOUR_KEY

MCP endpoint (recommended): OAuth — the client opens a Yarda sign-in; no key needed.

MCP endpoint (API key): Authorization: Bearer yarda_ak_YOUR_KEY — API-key callers also see the legacy compatibility tools.

What you can build

Yarda exposes the same AI pipeline that powers its apps as a developer API.

AI Landscape Designs

Generate 2D site plans and 3D oblique renderings for any US property address.

Property Boundaries

Get satellite imagery and polygon boundary detection for any US address.

Material Estimates

Calculate material quantities and cost estimates from any design.

AI-Powered Agents

Use the MCP server to give Claude or ChatGPT landscape design capabilities.

Field Service Integrations

Embed Yarda designs inside Jobber, Housecall Pro, or your own CRM.

Proposal Automation

Auto-generate landscape proposals with designs, materials, and pricing.

Ready to build?

Create a free account, then email support@yarda.ai to request your API key.

Have questions? support@yarda.ai