Upload custom code system

post

https://{instanceUrl}/construe/upload

Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
Returns 202 immediately; embedding generation runs asynchronously. Poll
GET /construe/codes/systems/{codesystem}?version={version} to check when status
transitions from "processing" to "ready" or "failed".

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Upload a custom code system. The format field determines which additional fields are required:

csv: requires file, code_col, desc_col
json: requires either file (base64-encoded JSON array) or codes (direct JSON array)

name

string

required

Name of the code system. Names are case-insensitive and stored uppercase.
Builtin system names (e.g. ICD-10-CM, SNOMED_CT_US_LITE, LOINC, CPT, etc.) are
reserved and cannot be used for custom uploads; attempts return HTTP 403 Forbidden.

version

string

required

Version of the code system

revision

number

Optional revision number

format

string

enum

required

Upload format

Allowed:

file

string

The file contents as a base64-encoded string.
For CSV format, this is the CSV file contents.
For JSON format, this is a base64-encoded JSON array; prefer using 'codes' instead.

code_col

string

Column name containing codes (required for CSV format)

desc_col

string

Column name containing descriptions (required for CSV format)

defn_col

string

Optional column name containing long definitions (for CSV format)

codes

array of objects

The codes to upload as a JSON array (JSON format only).
This is the preferred way to upload JSON codes, as it avoids unnecessary base64 encoding.
If both 'codes' and 'file' are provided, 'codes' takes precedence.

codes

replace

boolean

Defaults to false

If true, replaces an existing code system with the same name and version.
Builtin systems cannot be replaced; attempts to do so return HTTP 403 Forbidden.
When false (default), uploading a duplicate returns 409 Conflict.

Responses

400

Invalid request format or parameters

401

Unauthorized

403

Forbidden (not on a dedicated instance, or replace=true on a builtin system)

409

Code system version already exists (when replace=false)

424

Failed dependency (error processing or storing the code system)

500

Server error

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Upload accepted for asynchronous processing