OpenAPI V2 Overview
This page introduces common conventions for API 2.0 (OpenAPI V2), the OpenAPI document URL, scenario entry points, and the API index.
Base URL
- Base URL:
https://open.cli.im - Path prefix:
/api/v2/rpc/, so full endpoints look likehttps://open.cli.im/api/v2/rpc/{service}/{method}.
For authentication, see Authentication (OpenAPI V2).
All V2 endpoints are POST and use application/json request bodies.
OpenAPI JSON URL
You can fetch the V2 OpenAPI 3.x spec from:
- URL:
https://open.cli.im/openapi.json
No authentication is required for this URL; you can GET it directly. It includes paths, request schemas, responses, and error descriptions for all /api/v2/rpc/* endpoints.
For MCP usage, see MCP (OpenAPI V2).
Where to start
- First-time integration: read Authentication (OpenAPI V2)
- Import into Swagger/Postman or generate SDKs: use
https://open.cli.im/openapi.json - Need recommended call order by business goal: see Scenarios
- Need endpoint-by-endpoint fields and examples: continue with the index below
API index
QR Codes
| API | Path | Description |
|---|---|---|
| QR code content | POST /api/v2/rpc/qrcodes/getContent | Get display content (meta + fields) by coding or URL |
| QR code operation elements | POST /api/v2/rpc/qrcodes/getOperation | Get flattened operation-element list by coding or URL |
Forms and Records
| API | Path | Description |
|---|---|---|
| Get form template | POST /api/v2/rpc/forms/getTemplate | Get form structure by tpl_id |
| Get a single record | POST /api/v2/rpc/record/getRecord | Get record detail by record_id or record_url |
| Get records | POST /api/v2/rpc/record/getRecords | Query records by filters, keyword, time, and pagination |
| Get form list | POST /api/v2/rpc/record/getFormList | List forms under current org with pagination |
| Add record | POST /api/v2/rpc/record/addRecord | Submit one record by code_id + tpl_id |
| Verify record certificate | POST /api/v2/rpc/certificates/verify | Verify credential records (next status or target status) |
Shared reference
- Form component types overview:
field_typenaming, categories, shared semantics, and conventions.