{"version":"1.0","humanDocs":"/api-docs/","authentication":{"scheme":"Bearer","header":"Authorization: Bearer ae_live_...","alternative":"x-api-key"},"scopes":{"actions":["read","write","ai","actions","admin"],"format":"`action:resource`, e.g. read:*, write:tasks, ai:ask, actions:execute, admin:*","yours":null},"paging":{"params":["limit (max 200)","offset","order","dir=asc|desc"],"response":"{ data, meta: { total, limit, offset, hasMore } }"},"filtering":{"equality":"?status=open","ranges":"?date_from=2026-01-01&date_to=2026-02-01","text":"?q=free text","farm":"?farmId=..."},"resources":[{"resource":"farms","label":"Farms","scope":"org","readonly":false,"writableFields":["name","vertical","location","latitude","longitude","areaDunam","currency","notes"],"requiredOnCreate":["name"],"filters":["vertical"],"ranges":[],"searchable":true,"defaultOrder":"createdAt","deletable":true},{"resource":"barns","label":"Barns / spaces","scope":"farm","readonly":false,"writableFields":["name","capacity","areaSqm","barnType","controller","status","notes","latitude","longitude","headingDeg"],"requiredOnCreate":["name"],"filters":["status","barnType"],"ranges":[],"searchable":true,"defaultOrder":"name","deletable":true},{"resource":"flocks","label":"Flocks / growth cycles","scope":"farm","readonly":false,"writableFields":["barnId","code","breed","chicksOrdered","chicksReceived","orderTotal","arrivalAgeDays","placementDate","pricePerChick","targetWeightKg","plannedMarketDate","status","supplierId","batchCode","notes"],"requiredOnCreate":["barnId","placementDate"],"filters":["status","barnId","breed","batchCode"],"ranges":["placementDate"],"searchable":true,"defaultOrder":"placementDate","deletable":true},{"resource":"daily-logs","label":"Daily log entries","scope":"flock","readonly":false,"writableFields":["flockId","date","ageDays","mortality","culls","eggs","eggsBroken","avgWeightGr","feedKg","waterL","tempMin","tempMax","tempAvg","humidity","notes"],"requiredOnCreate":["flockId","date"],"filters":["flockId"],"ranges":["date"],"searchable":false,"defaultOrder":"date","deletable":true,"module":"daily"},{"resource":"alerts","label":"Alerts","scope":"farm","readonly":false,"writableFields":["barnId","flockId","severity","category","title","message","status","resolutionNote","feedback","feedbackNote"],"requiredOnCreate":["title"],"filters":["status","severity","category","barnId"],"ranges":["createdAt"],"searchable":true,"defaultOrder":"createdAt","deletable":true,"module":"alerts"},{"resource":"tasks","label":"Tasks","scope":"farm","readonly":false,"writableFields":["barnId","title","details","assignee","priority","status","dueDate","frequency"],"requiredOnCreate":["title"],"filters":["status","priority","assignee","barnId","frequency"],"ranges":["dueDate","createdAt"],"searchable":true,"defaultOrder":"createdAt","deletable":true,"module":"tasks"},{"resource":"task-comments","label":"Task thread messages","scope":"parent","readonly":false,"writableFields":["taskId","kind","text","authorName"],"requiredOnCreate":["taskId","text"],"filters":["taskId","kind"],"ranges":[],"searchable":false,"defaultOrder":"createdAt","deletable":true},{"resource":"field-reports","label":"Field reports from workers","scope":"farm","readonly":false,"writableFields":["barnId","flockId","rawText","source","lang","authorName","category","severity","summaryHe","isQuestion","status","replyText"],"requiredOnCreate":["rawText"],"filters":["status","severity","category","isQuestion","source","barnId"],"ranges":["createdAt"],"searchable":true,"defaultOrder":"createdAt","deletable":true},{"resource":"events","label":"Timeline events","scope":"farm","readonly":false,"writableFields":["barnId","flockId","kind","title","details","ts"],"requiredOnCreate":["kind","title"],"filters":["kind","barnId","flockId"],"ranges":["ts","createdAt"],"searchable":true,"defaultOrder":"ts","deletable":true},{"resource":"media","label":"Photos, drawings and documents","scope":"farm","readonly":false,"writableFields":["barnId","flockId","deviceId","contactId","name","description","category","tags","kind","source"],"requiredOnCreate":[],"filters":["category","barnId","flockId","aiSeverity","source","kind"],"ranges":["createdAt"],"searchable":true,"defaultOrder":"createdAt","deletable":true,"note":"Binary content is excluded from listings — fetch /media/{id}/file for the bytes."},{"resource":"devices","label":"Devices (controllers, cameras, sensors)","scope":"farm","readonly":false,"writableFields":["barnId","kind","model","serial","status","installedAt","notes"],"requiredOnCreate":["kind"],"filters":["kind","status","barnId"],"ranges":[],"searchable":true,"defaultOrder":"createdAt","deletable":true},{"resource":"integrations","label":"Integrations / ingest endpoints","scope":"farm","readonly":false,"writableFields":["barnId","name","kind","vendor","endpoint","authRef","pollMinutes","status","notes"],"requiredOnCreate":["kind"],"filters":["kind","status","vendor"],"ranges":[],"searchable":true,"defaultOrder":"createdAt","deletable":true},{"resource":"env-readings","label":"Environment readings","scope":"barn","readonly":false,"writableFields":["barnId","ts","temp","humidity","co2","nh3","waterL","feedKg","source","notes"],"requiredOnCreate":["barnId"],"filters":["barnId","source"],"ranges":["ts"],"searchable":false,"defaultOrder":"ts","deletable":true},{"resource":"vision-events","label":"Camera / vision detections","scope":"farm","readonly":false,"writableFields":["barnId","deviceId","kind","value","unit","source","confidence","meta","ts"],"requiredOnCreate":["kind"],"filters":["kind","source","barnId"],"ranges":["ts","createdAt"],"searchable":false,"defaultOrder":"ts","deletable":true},{"resource":"controller-commands","label":"Two-way controller commands","scope":"farm","readonly":false,"writableFields":["barnId","integrationId","deviceId","command","params","mode","status","requestedBy"],"requiredOnCreate":["command"],"filters":["status","barnId","mode"],"ranges":[],"searchable":false,"defaultOrder":"createdAt","deletable":true},{"resource":"automations","label":"Automation rules","scope":"farm","readonly":false,"writableFields":["barnId","name","deviceKind","mode","trigger","action","enabled"],"requiredOnCreate":["name"],"filters":["enabled","barnId","deviceKind"],"ranges":[],"searchable":false,"defaultOrder":"createdAt","deletable":true},{"resource":"feed-deliveries","label":"Feed deliveries","scope":"farm","readonly":false,"writableFields":["flockId","date","feedType","quantityKg","pricePerTon","totalCost","supplierId","notes"],"requiredOnCreate":["date","quantityKg"],"filters":["feedType","flockId","supplierId"],"ranges":["date"],"searchable":false,"defaultOrder":"date","deletable":true,"module":"feed"},{"resource":"feed-orders","label":"Feed orders","scope":"farm","readonly":false,"writableFields":["flockId","feedType","quantityKg","supplierId","status","orderDate","dueDate","deliveredAt","pricePerTon","notes"],"requiredOnCreate":["quantityKg"],"filters":["status","feedType"],"ranges":["dueDate"],"searchable":false,"defaultOrder":"createdAt","deletable":true,"module":"feed"},{"resource":"expenses","label":"Expenses","scope":"farm","readonly":false,"writableFields":["flockId","barnId","date","category","description","amount","supplierId"],"requiredOnCreate":["date","amount","category"],"filters":["category","flockId"],"ranges":["date"],"searchable":true,"defaultOrder":"date","deletable":true,"module":"expenses"},{"resource":"sales","label":"Sales","scope":"flock","readonly":false,"writableFields":["flockId","customerId","date","birdsCount","totalWeightKg","pricePerKg","totalAmount","condemnedCount","condemnedKg","notes"],"requiredOnCreate":["flockId","date"],"filters":["flockId","customerId"],"ranges":["date"],"searchable":false,"defaultOrder":"date","deletable":true,"module":"sales"},{"resource":"treatments","label":"Treatments & vaccinations","scope":"flock","readonly":false,"writableFields":["flockId","date","kind","product","reason","cost","vetName","notes"],"requiredOnCreate":["flockId","date","kind"],"filters":["flockId","kind"],"ranges":["date"],"searchable":false,"defaultOrder":"date","deletable":true,"module":"treatments"},{"resource":"medicine","label":"Medicine inventory","scope":"farm","readonly":false,"writableFields":["name","kind","quantity","unit","expiryDate","batchNumber","minQuantity","supplierId","notes"],"requiredOnCreate":["name"],"filters":["kind"],"ranges":["expiryDate"],"searchable":true,"defaultOrder":"expiryDate","deletable":true,"module":"treatments"},{"resource":"contacts","label":"Contacts (suppliers, vet, staff)","scope":"farm","readonly":false,"writableFields":["barnId","kind","name","phone","email","company","notes","language"],"requiredOnCreate":["name"],"filters":["kind","barnId"],"ranges":[],"searchable":true,"defaultOrder":"name","deletable":true},{"resource":"tenders","label":"Tenders","scope":"farm","readonly":false,"writableFields":["title","direction","category","description","quantity","unit","deadline","deliveryDate","status"],"requiredOnCreate":["title"],"filters":["status","direction","category"],"ranges":["deadline"],"searchable":true,"defaultOrder":"createdAt","deletable":true,"module":"market"},{"resource":"tender-bids","label":"Supplier bids","scope":"parent","readonly":false,"writableFields":["tenderId","supplierName","phone","email","price","currency","deliveryDate","notes","status"],"requiredOnCreate":["tenderId"],"filters":["tenderId","status"],"ranges":[],"searchable":false,"defaultOrder":"createdAt","deletable":true},{"resource":"market-orders","label":"Purchase / sale orders","scope":"farm","readonly":false,"writableFields":["kind","direction","category","title","details","quantity","unit","price","needByDate","supplierName","contactId","tenderId","status"],"requiredOnCreate":["title"],"filters":["status","kind","direction"],"ranges":["needByDate"],"searchable":true,"defaultOrder":"createdAt","deletable":true,"module":"market"},{"resource":"users","label":"Organization users","scope":"org","readonly":false,"writableFields":["name","phone","lang","status","role"],"requiredOnCreate":[],"filters":["role","status"],"ranges":[],"searchable":true,"defaultOrder":"createdAt","deletable":false},{"resource":"farm-access","label":"Per-farm user assignments","scope":"farm","readonly":false,"writableFields":["farmId","userId","role","barnIds","modules"],"requiredOnCreate":["farmId","userId"],"filters":["userId","role"],"ranges":[],"searchable":false,"defaultOrder":"createdAt","deletable":true},{"resource":"agent-runs","label":"System agent runs","scope":"global","readonly":true,"writableFields":[],"requiredOnCreate":[],"filters":["agentKey","status","trigger"],"ranges":["startedAt"],"searchable":false,"defaultOrder":"startedAt","deletable":false},{"resource":"reg-items","label":"Regulatory intelligence items","scope":"global","readonly":true,"writableFields":[],"requiredOnCreate":[],"filters":["bodyKey","sourceKey","severity","category","locality"],"ranges":["publishedAt"],"searchable":true,"defaultOrder":"publishedAt","deletable":false},{"resource":"support-tickets","label":"Support tickets","scope":"org","readonly":false,"writableFields":["status","kind","priority","assignee","lang"],"requiredOnCreate":[],"filters":["status","kind","channel","priority"],"ranges":[],"searchable":true,"defaultOrder":"createdAt","deletable":false},{"resource":"chat-messages","label":"Albert conversation history","scope":"farm","readonly":true,"writableFields":[],"requiredOnCreate":[],"filters":["role","userId"],"ranges":["createdAt"],"searchable":false,"defaultOrder":"createdAt","deletable":false}],"intelligence":[{"path":"GET /context","purpose":"Everything about one farm in a single object — structure, live flocks, alerts, tasks, people, hardware, money, plus a natural-language narrative ready for a prompt.","params":["farmId","depth=summary|full"]},{"path":"GET /insights","purpose":"What the system already concluded: action plan, health score, profit engine, leaks, benchmark, labour savings, market and feed prices, cash-flow, barn comparison, placement plan, supplier scores, weather, smart weights, risk ledger.","params":["farmId","include=actionPlan,health,profit,..."]},{"path":"GET /gaps","purpose":"What is MISSING: setup gaps, un-entered daily logs, unanswered worker questions, unresolved alerts, unweighed flocks, expired medicine, faulty integrations, data-quality problems.","params":["farmId"]},{"path":"GET /digest","purpose":"The morning briefing as data: overnight alerts and reports, tasks due, mortality vs 7-day average, flocks missing today, top actions.","params":["farmId"]},{"path":"GET /portfolio","purpose":"Every farm this key can see with headline numbers — for a multi-farm brain.","params":[]},{"path":"GET /activity","purpose":"Unified activity log across alerts, reports, events and data entry, each row scored by importance.","params":["farmId","from","to","kinds","minScore"]},{"path":"GET /search","purpose":"Cross-module text search.","params":["q","farmId","types"]}],"ai":[{"path":"POST /ask","purpose":"Ask in natural language (any of he/en/th/es/zh). Returns an answer grounded in this farm, and may return a proposed action.","body":{"farmId":"string","question":"string","lang":"he|en|th|es|zh","execute":"boolean — allow the model to run its own action"},"requires":"ai:ask","available":true},{"path":"POST /actions","purpose":"Execute one whitelisted action deterministically (no AI in the loop).","body":{"farmId":"string","type":"see actionTypes","...":"action fields"},"requires":"actions:execute"},{"path":"POST /actions/undo","purpose":"Reverse a previously executed action using the undo descriptor it returned.","requires":"actions:execute"}],"actionTypes":["create_task","complete_task","create_order","create_expense","create_contact","create_barn","create_flock","log_daily","create_alert","create_medicine","create_feed_delivery","set_farm_location","set_barn_location","navigate"],"webhooks":{"events":["alert.created","alert.critical","alert.resolved","task.created","task.completed","field_report.created","field_report.question","field_report.critical","flock.placed","flock.closed","daily_log.created","sale.created","expense.created","feed.delivered","media.analyzed","gap.detected","brain.scan"],"signature":"x-agenticeye-signature: sha256=HMAC(secret, timestamp + \".\" + rawBody)","manage":"GET/POST/DELETE /v1/platform/webhooks"},"passthrough":{"path":"/v1/platform/os/*","purpose":"Any of the 200+ OS endpoints with this key's identity — the guarantee that anything the app can do, the API can do.","example":"/v1/platform/os/dashboard?farmId=..."},"limits":{"rateLimitPerMinute":"per key, see x-ratelimit-* response headers","maxPageSize":200,"maxBodyBytes":6291456}}