canonical: https://jentic.com/apis/swaggerhub.hackney/academy-api

# Hackney Academy API

Academy API version v1.0. Please check older versions for depreciated endpoints. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically gets council tax records by first name and last name from database, gets a council tax record by account reference from database.. Covers 6 operations with apiKey authentication.

## Scope

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

## Capabilities

- Gets council tax records by first name and last name from database
- Manage developer tools data programmatically
- Integrate Academy API into automated workflows
- Query and filter Academy API records by parameters
- Monitor Academy API operational status and events

## Use cases

### Developer Tools Operations

Use the Academy API to perform developer tools operations programmatically. The API provides 6 endpoints covering core functionality including gets council tax records by first name and last name from database, gets a council tax record by account reference from database., gets council tax notes by account reference from database..

Example prompt: Call GET /api/v1/council-tax/search to gets council tax records by first name and last name from database

### Automated CouncilTax Management

Automate counciltax operations by combining multiple Academy API endpoints. Agents can gets a council tax record by account reference from database. and then gets council tax notes by account reference from database. in a single workflow.

Example prompt: Call GET /api/v1/council-tax/{councilTaxId} to gets a council tax record by account reference from database., then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Academy 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 apiKey tokens manually.

Example prompt: Search Jentic for 'gets council tax records by first name and last name from database', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/v1/council-tax/search | Gets council tax records by first name and last name from database |
| GET | /api/v1/council-tax/{councilTaxId} | Gets a council tax record by Account Reference from database. |
| GET | /api/v1/council-tax/{councilTaxId}/notes | Gets Council tax notes by Account Reference from database. |
| GET | /api/v1/benefits/search | Gets housing benefits records by First Name and Last Name from database |
| GET | /api/v1/benefits/{benefitsId} | Gets a housing benefits record by Benefits ID. |
| GET | /api/v1/benefits/{benefitsId}/notes | Gets housing benefits notes by Benefits ID. |

## Key resources

- **CouncilTax** — Operations related to CouncilTax
- **HousingBenefits** — Operations related to HousingBenefits

## Why Jentic

- **Setup:** Wiring the Hackney Academy API by hand means sending its API-key request header on every request, coding the council-tax and benefits calls, and handling paging and retries yourself. Through Jentic you install once, import the Academy API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** This API puts the record id in the URL path (/api/v1/council-tax/{councilTaxId}, /api/v1/benefits/{benefitsId}), so a rule can pin your agent to one council-tax or benefits record: it can read that record and its notes and nothing else. All operations here are reads, and you choose which the agent may call.
- **Credential handling:** Your Academy API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'search council tax records by name' or 'get notes for a benefits record', and Jentic returns the matching Academy 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 Academy API use?

The Academy API uses an API key passed in the `X-Api-Key` header. 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 gets council tax records by first name and last name from database with the Academy API?

Yes. Use the GET /api/v1/council-tax/search endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Academy 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 gets council tax records by first name and last name from database through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'gets council tax records by first name and last name from database'. Jentic returns the matching Academy API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

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

The Academy API exposes 6 endpoints covering counciltax, housingbenefits operations.

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

Yes. Because you run Jentic One yourself, your own rules decide which Academy API operations and credentials the agent may use, and every operation here is read-only. Since the record id sits in the URL path (/api/v1/council-tax/{councilTaxId} and /api/v1/benefits/{benefitsId}), you can pin the agent to a single council-tax or benefits record so it reads only that record and its notes. You can also restrict it to the search endpoints alone, or block any operation you do not want it to call.
