Using AI agents with RealEye

Published: 1 min read

RealEye can be operated by an AI agent through two surfaces: the public HTTP API (api2) and the RealEye web UI. Each is good at different things, and some operations exist only in one of them.

This page points to a machine-readable agent skill that explains the choice, how to authenticate, and which operations the public API cannot do.

#What the agent skill covers

  • How to choose between the public api2 API and the web UI for each task (studies, stimuli, results and data export, participants, and Retail/Shelf and mockup studies).
  • Authentication with the X-AUTH-TOKEN header, the supported error codes, and the license requirement for API access.
  • The operations that are not available through the public API, with the UI path for each.
  • The version of the API documentation the skill was written against, so it is easy to see when the skill is out of date.

#Download the agent skill

#API documentation

#Notes

  • The public API contract lives in the API documentation above; the agent skill is a guide for agents, not a replacement for that documentation.
  • Access to the public API requires a license that includes the API module.