canonical: https://jentic.com/apis/rook-connect.com/rook-connect

# Rook Connect ROOK

Intro [ROOK](https://docs.tryrook.io/docs/Definitions#rook) is a set of services that simplifies the collection, processing, and delivering of [Users'](https://docs.tryrook.io/docs/Definitions#User) [HealthData](https://docs.tryrook.io/docs/Definitions#health-data) from various data sources. Testing You can use the following constants to test the API and receive default responses: - client_uuid = . The API exposes 20 endpoints secured with basic authentication.

## For AI agents

Programmatically [user][data sources][authorizers], [user][data sources][authorized]. Covers 20 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- [User][Data Sources][Authorizers]
- [User][Info]
- [Physical][Summary]
- [Physical][Events][Activity]
- [Physical][Events][Heart Rate]

## Use cases

### Developer Tools Operations

Use the ROOK to perform developer tools operations programmatically. The API provides 20 endpoints covering core functionality including [user][data sources][authorizers], [user][data sources][authorized], [user][info].

Example prompt: Call GET `/api/v1/client_uuid/{client_uuid}/user_id/{user_id}/data_sources/authorizers` to [user][data sources][authorizers]

### Automated Health Management

Automate health operations by combining multiple ROOK endpoints. Agents can [user][data sources][authorized] and then [user][info] in a single workflow.

Example prompt: Call GET `/api/v1/user_id/{user_id}/data_sources/authorized` to [user][data sources][authorized], then verify the result

### AI Agent Integration via Jentic

AI agents discover and call ROOK endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for '[user][data sources][authorizers]', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/v1/client_uuid/{client_uuid}/user_id/{user_id}/data_sources/authorizers` | [User][Data Sources][Authorizers] |
| GET | `/api/v1/user_id/{user_id}/data_sources/authorized` | [User][Data Sources][Authorized] |
| GET | `/v2/processed_data/user/info` | [User][Info] |
| POST | `/api/v1/user_id/{user_id}/data_sources/revoke_auth` | [User][Data Sources][Revoke] |
| GET | `/v2/processed_data/physical_health/summary` | [Physical][Summary] |
| GET | `/v2/processed_data/physical_health/events/activity` | [Physical][Events][Activity] |
| GET | `/v2/processed_data/physical_health/events/heart_rate` | [Physical][Events][Heart Rate] |
| GET | `/v2/processed_data/physical_health/events/oxygenation` | [Physical][Events][Oxygenation] |

## Key resources

- **Health** — Operations related to Health
- **User** — Operations related to User
- **PhysicalHealthSummary** — Operations related to PhysicalHealthSummary
- **SleepHealthSummary** — Operations related to SleepHealthSummary
- **Nutrition** — Operations related to Nutrition

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 27 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 66 / 100
  - Developer Experience & Jentic Compatibility: 59 / 100
  - AI-Readiness & Agent Experience: 14 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/rook-connect.com/rook-connect/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring ROOK by hand means implementing its HTTP basic auth and sending it on every request and handling the request plumbing yourself. Through Jentic you install once, import ROOK from the API Directory, store the basic credentials once, and your agent calls it.
- **Permission scoping:** ROOK puts the client and user ids in the URL path (`/client_uuid/{client_uuid}/user_id/{user_id}/...`), so a rule can pin your agent to one user's data. You choose the operations it may call, so ones like revoking a data-source authorization are not included unless you add them.
- **Credential handling:** Your ROOK basic credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list a user's authorized data sources' or 'get a physical health summary', and Jentic returns the matching ROOK operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the ROOK use?

The ROOK uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I [user][data sources][authorizers] with the ROOK?

Yes. Use the GET `/api/v1/client_uuid/{client_uuid}/user_id/{user_id}/data_sources/authorizers` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ROOK?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I [user][data sources][authorizers] through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for '[user][data sources][authorizers]'. Jentic returns the matching ROOK operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the ROOK have?

The ROOK exposes 20 endpoints covering health, user, physicalhealthsummary operations.

### Can I limit what my agent is allowed to do with the ROOK API?

Yes. Because you run Jentic One yourself, your own rules decide which ROOK operations and credentials your agent may use. ROOK carries the client and user ids in the URL path, so you can pin an agent to a single user's health data, and you choose exactly which operations it may call. That means read operations like getting a physical health summary or listing a user's authorized data sources can be allowed while a state-changing call such as revoking a data-source authorization stays off unless you add it.