Hmcts Dts Case Documents AI Responses API

Name: Case Documents AI Responses API
Brand: Case Documents AI Responses API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsTesting Qanone12 Endpoints

Install Jentic One Beta

Connect the Case Documents AI Responses API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Case Documents AI Responses API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Case Documents AI Responses API.

List canonical queries (id + label)

Get a canonical query (id + label)

Set or update the canonical label for a query (idempotent)

GET STARTED

Start building with Case Documents AI Responses API

Explore with Jentic

View OpenAPI Document

For Agents

Programmatically list canonical queries (id + label), get a canonical query (id + label). Covers 12 operations.

Use for: I need to canonical queries (id + label), I want to a canonical query (id + label), Search for set or update the canonical label for a query (idempotent), Find all upsert versioned **query definitions** (no status, no label) effective at a time

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

Use Cases

Patterns agents use Case Documents AI Responses API for, with concrete tasks.

★ Developer Tools Operations

Use the Case Documents AI Responses API to perform developer tools operations programmatically. The API provides 12 endpoints covering core functionality including list canonical queries (id + label), get a canonical query (id + label), set or update the canonical label for a query (idempotent).

Call GET /query-catalogue to list canonical queries (id + label)

Automated Query Catalogue Management

Automate query catalogue operations by combining multiple Case Documents AI Responses API endpoints. Agents can get a canonical query (id + label) and then set or update the canonical label for a query (idempotent) in a single workflow.

Call GET /query-catalogue/{queryId} to get a canonical query (id + label), then verify the result

AI Agent Integration via Jentic

AI agents discover and call Case Documents AI Responses 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.

Search Jentic for 'list canonical queries (id + label)', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

12 endpoints — versioned **queries** (user text + normalized prompt + lifecycle status) and **answers** linked to a case.

METHOD

PATH

DESCRIPTION

GET

/query-catalogue

List canonical queries (id + label)

GET

/query-catalogue/{queryId}

Get a canonical query (id + label)

PUT

/query-catalogue/{queryId}/label

Set or update the canonical label for a query (idempotent)

POST

/queries

Upsert versioned **query definitions** (no status, no label) effective at a time

GET

/queries

List queries for a Case (as-of view)

GET

/queries/{queryId}

Get a single query for a Case (as-of view)

GET

/queries/{queryId}/versions

List **definition** version history for a query (no status)

GET

/document/{documentId}/content

Download material by document ID

GET

/query-catalogue

List canonical queries (id + label)

GET

/query-catalogue/{queryId}

Get a canonical query (id + label)

PUT

/query-catalogue/{queryId}/label

Set or update the canonical label for a query (idempotent)

POST

/queries

Upsert versioned **query definitions** (no status, no label) effective at a time

GET

/queries

List queries for a Case (as-of view)

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

This Case Documents AI Responses API declares no credential, so there is nothing to store. If your deployment later requires one, your own Jentic One instance stores it encrypted and injects it at execution time so it never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'list canonical queries' or 'get document content by id', and Jentic returns the matching Case Documents AI Responses API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Github

Alternative developer tools API

Choose Github when you need a different approach to developer tools operations

Alternative

Gitlab

Alternative developer tools API

Choose Gitlab when you need a different approach to developer tools operations

FAQs

Specific to using Case Documents AI Responses API through Jentic.

What authentication does the Case Documents AI Responses API use?

The Case Documents AI Responses 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 list canonical queries (id + label) with the Case Documents AI Responses API?

Yes. Use the GET /query-catalogue endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Case Documents AI Responses 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 list canonical queries (id + label) through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list canonical queries (id + label)'. Jentic returns the matching Case Documents AI Responses API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

How many endpoints does the Case Documents AI Responses API have?

The Case Documents AI Responses API exposes 12 endpoints covering query catalogue, queries, answers operations.

Can I limit what my agent is allowed to do with the Case Documents AI Responses API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use with the Case Documents AI Responses API. Since this API puts the query id and document id in the URL path, such as GET /queries/{queryId} and GET /document/{documentId}/content, you can pin the agent to a single query or document so it only reads that query, its versions, or that document content. You choose the operations it may call, so a write like PUT /query-catalogue/{queryId}/label to set a canonical query label is excluded unless you explicitly add it.