Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wiseyield.co/llms.txt

Use this file to discover all available pages before exploring further.

API surface (2026-05-18) — the WiseYield public, API-key-authenticated surface is the versioned /api/v1/* namespace. 51 endpoints across 7 scope families are live: Farms · Crops · Fields/Blocks/Plants · Tasks/Recurring/Templates · Crop Library · Analytics · Market Intelligence. API key minting is Summit-tier only. Pages listed under API Reference → AI / Billing / Team / User / Onboarding describe the broader dashboard surface and are still session-authenticated rather than API-key-callable; they ship to /v1/* in upcoming batches.

​
What WiseYield does

WiseYield is the AI-powered agricultural intelligence platform — three product surfaces working off a shared data model:
  • Crop intelligence — soil + climate + market grounding feeding crop, variety, and rotation recommendations.
  • Market insights — commodity pricing, demand signals, and price forecasting tuned to the user’s portfolio.
  • Farm management — farms, fields, blocks, irrigation, fertigation, payroll, finance, and SOP-driven task execution.
The API exposes the data and decision endpoints that power these surfaces.

​
Get started

Quickstart

Issue an API key and make your first request in 5 minutes

Authentication

Key format, scopes, rate limits, and error codes

API Reference

All currently documented endpoints

Guides

Crop recommendations, yield, weather, webhooks

​
What you can do today

​
Build against the versioned API

A Summit-tier user can run an end-to-end workflow today — list farms, list crops on a farm, create tasks, browse the crop library, pull analytics: 
# List farms
curl 'https://www.wiseyield.co/api/v1/farms?limit=10' \
  -H "Authorization: Bearer $WISEYIELD_API_KEY"

# Get the composite health score for one farm
curl "https://www.wiseyield.co/api/v1/farms/$FARM_ID/health-score" \
  -H "Authorization: Bearer $WISEYIELD_API_KEY"

# Read anonymized regional crop prices (privacy threshold ≥5 farms)
curl "https://www.wiseyield.co/api/v1/market/regional-prices?country=Egypt" \
  -H "Authorization: Bearer $WISEYIELD_API_KEY"

# Create a task on a crop
curl -X POST "https://www.wiseyield.co/api/v1/tasks" \
  -H "Authorization: Bearer $WISEYIELD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "cropId": "...", "title": "Apply foliar K", "dueDate": "2026-06-01" }'

​
Coming next

Remaining surface (batches 8-11): AI (vision routes + recommendation triggers — ai:read / ai:write), Billing (subscription, invoices, usage — billing:read / billing:write), Team (members, invitations — team:read / team:write), User Profile (user:read / user:write). Pages for those endpoints are noindexed today; they’ll be promoted into nav as the routes ship. See V1_API_EXPANSION_PLAN.md for the public engineering plan.

​
Rate limits

API requests are rate-limited per user, by subscription tier, sliding-window:
TierLimit
Expired trial3 requests/hour
Seed25 requests/hour
Sprout50 requests/hour
Trial / Harvest100 requests/hour
Grove200 requests/hour
Summit1,000 requests/hour
A 14-day trial grants Harvest-level access. Billing is EUR-denominated; checkout currency is auto-detected per the buyer’s country via Dodo Adaptive Currency — no manual selector. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (ISO 8601). See Authentication for the full rate-limit contract.

​
Conventions

  • Base URL: https://www.wiseyield.co
  • Versioning: documented under /api/v1/* where supported.
  • Auth: Authorization: Bearer wy_live_… or wy_test_….
  • Content type: application/json on requests and responses.
  • Timestamps: ISO 8601 in UTC.
  • Pagination: ?page= + ?limit= (max 100), responses include a pagination object.
  • Errors: { error, code?, message?, details? } with HTTP status.

​
Support