> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Use with an agent

> Discover the API contract and make a first call from an AI agent.

Give your agent the [documentation index](/llms.txt) 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](/llms.txt) to find the relevant pages.
* Use [Choose a research task](/guides/index) to select a workflow before loading
  detailed schemas. Load the relevant guide and operation reference as needed.
* Append `.md` to a page URL for its Markdown representation, for example
  `/getting-started/quickstart.md`.
* Follow [the API catalog](/.well-known/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.

## Give the agent a research question

For example:

> Use the task index to find Texas homeowners filings for a carrier whose name
> contains Travelers, submitted during 2025. Resolve the carrier identity first,
> return two relevant filings, and explain which forms, rate data, or source
> documents support the answer. State any coverage limits or changes to the query.

Or:

> Find a Texas document discussing roof exclusions. Read enough of the source
> document to explain one exclusion. Keep the returned filing/file IDs and the
> version or text revision you actually read; identify any unproven link between
> search passages and the original bytes.

The [research guides](/guides/index) cover discovery, carrier/MGA relationships,
text checkpoints, source verification, and recovery. Ask the agent to keep a
sanitized record of request shapes, returned IDs, and observation times rather
than credentials or signed URLs.

Use documentation for the API host receiving the key. Canary docs can describe
capabilities before that host finishes deploying them. Verify `/users/me`, then
the first operation needed for the task; treat an unexpected route or validation
failure as a problem to diagnose, not empty research data. See
[environment mismatch recovery](/guides/pagination-and-recovery#recognize-an-environment-mismatch).

Only operations listed in the V2 reference belong to this public API surface.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.