Custom Terms

This endpoint returns a list of the custom terms in your organization, ordered by name. The list includes ids and metadata only — the terms text is omitted because it can be very large. Use GET /v1/custom_terms/{id} to retrieve the full body of a specific term.

Custom terms must be enabled for your organization; these endpoints return 404 otherwise.

This endpoint creates new custom terms. Text terms take a JSON body whose markdown body is published as released version 1. File terms take a multipart/form-data request with term_type=file and a docx file part; the document is published as version 1 and converted to a pdf asynchronously, so poll the term's conversion_status until it is ready. Either shape is attributed to the user given by user_email or user_id.

Custom terms must be enabled for your organization; these endpoints return 404 otherwise.

This endpoint returns the details of specific custom terms by UUID, including the full terms text of the released version as body. File type terms return null for body and include conversion_status (processing, ready, or failed) for the released version's pdf conversion.

Custom terms must be enabled for your organization; these endpoints return 404 otherwise.

This endpoint renames custom terms. Only the name can be changed here — versions are immutable, so the terms text changes by publishing a new version with POST /v1/custom_terms/{id}/versions. Body and term_type in the request are ignored.

Custom terms must be enabled for your organization; these endpoints return 404 otherwise.

This endpoint publishes a new version of custom terms. For text terms the markdown body becomes the released version; for file terms send multipart/form-data with a docx file part, which becomes the released version and converts to a pdf asynchronously. Existing versions are immutable and stay unchanged. Provide user_email or user_id to record which user in your organization published it.

Custom terms must be enabled for your organization; these endpoints return 404 otherwise.