API Endpoints and HTTP methods
WoAG Occupation Coding Service User Guide
Coding Service endpoints and methods.
Released
30/06/2025
The API endpoints and their HTTP methods are outlined below in both the table and the diagram.
| Endpoint | Description | HTTP verb |
|---|---|---|
| /v1/topics | Retrieve a list of available topics. | GET |
| /v1/topics/{topic} | Describes the input format for the given topic. | GET |
| /v1/topics/{topic}/code | Synchronously codes a single record or small batch of records against the latest model for a given topic. | POST |
| /v1/topics/{topic}/models | Lists the available models and their input formats for a given topic. | GET |
| /v1/topics/{topic}/models/latest | Describes the input format for the latest model for a given topic. | GET |
| /v1/topics/{topic}/models/{model}/code | Synchronously codes a single record or small batch of records against a specific model for the given topic. | POST |
| /v1/topics/{topic}/batch-code | Creates a new asynchronous batch inference operation against the latest model for a given topic. | POST |
| /v1/topics/{topic}/models/{model}/batch-code | Creates a new asynchronous batch inference operation against a specific model for the given topic. | POST |
| /v1/topics/{topic}/batch-code/operations/{operation_id} | Checks the status of a batch inference operation. | GET |
| /v1/topics/{topic}/models/{model}/batch-code/operations/{operation_id} | Checks the status of a batch inference operation. | GET |
| /v1/security.txt | Returns contact details for reporting issues. | GET |
Image
Description
Flow chart showing http methods and their progression to asynchronous coding endpoints, synchronous coding endpoints, and informational endpoints for the Occupation Coding Service.