canonical: https://jentic.com/apis/swaggerhub.hmcts-dts/piloting-api

# Hmcts Dts Piloting API

A simple API for the experiments that will help shape the API strategy. The API exposes 1 endpoints.

## For AI agents

Programmatically getjudgebyid. Covers 1 operations.

## Scope

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

## Capabilities

- getJudgeById
- Manage developer tools data programmatically
- Integrate Piloting API into automated workflows
- Query and filter Piloting API records by parameters
- Monitor Piloting API operational status and events

## Use cases

### Developer Tools Operations

Use the Piloting API to perform developer tools operations programmatically. The API provides 1 endpoints covering core functionality including getjudgebyid.

Example prompt: Call GET /example/judges/{judge_id} to getjudgebyid

### Data Retrieval and Monitoring

Query Piloting API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Piloting API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Piloting API 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 none tokens manually.

Example prompt: Search Jentic for 'getjudgebyid', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /example/judges/{judge_id} | getJudgeById |

## Key resources

- **Judges** — Judge information within the judiciary domain

## Why Jentic

- **Setup:** Wiring the Piloting API by hand means pointing at its SwaggerHub-hosted mock server, tracking the version in the base path, and handling request and error shapes yourself. Through Jentic you install once, import the Piloting API from the API Directory, and your agent calls it.
- **Permission scoping:** The Piloting API puts the judge id in the URL path (/example/judges/{judge_id}), so a rule can pin your agent to one judge lookup: it reads that record and nothing else. You choose the operations it may call, so only the read you need is included unless you add more.
- **Credential handling:** The Piloting API declares no authentication, so there is no secret to pass. If the live endpoint later requires a credential, it is stored once, encrypted, by your own Jentic One instance and injected at execution time, never entering the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get a judge by id', and Jentic returns the matching Piloting API 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 Piloting API use?

The Piloting API uses no authentication. 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 getjudgebyid with the Piloting API?

Yes. Use the GET /example/judges/{judge_id} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Piloting API?

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 getjudgebyid through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'getjudgebyid'. Jentic returns the matching Piloting API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Piloting API have?

The Piloting API exposes 1 endpoints covering judges operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Piloting API operations and credentials the agent may use. The only operation is GET /example/judges/{judge_id}, and since the judge id sits in the URL path, a rule can pin the agent to a single judge lookup so it reads that one record and nothing else. You choose the operations it may call, so only the read you approve is included unless you add more.