Skip to main content
Give your agent this documentation site’s URL and an environment containing an Effective user API key. No SDK, CLI, or MCP installation is required to make REST requests.

​
Discover the documentation

  • Read the documentation index to find the relevant pages.
  • Append .md to a page URL for its Markdown representation, for example /getting-started/quickstart.md.
  • Follow the API catalog to download the OpenAPI document for supported operations, authentication, schemas, and response codes. The page menu also offers Download API spec.

​
First task

Ask your agent:
Read these docs and use the Effective API key in EFFECTIVE_API_KEY to verify my authenticated user and tenant. Do not print the key.
The agent should read the authentication guide and current-user operation, call GET /api/v2/users/me, and report the returned identity. A failed request should be reported with its HTTP status and error message. Only operations listed in the V2 reference are available through this API surface. Consult the live documentation for new capabilities and contract changes.