> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.markup.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.markup.ai/_mcp/server. # Create Category Type POST https://api.markup.ai/style-agent/terminology/category-types Content-Type: application/json Create a category type. Returns `409` if a type with the same `name` already exists. Reference: https://docs.markup.ai/developer-reference/api-reference/style-agent/terminology/create-category-type ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Body (application/json) This endpoint expects a CategoryTypeCreateRequest. - `name` (string, required) — Unique name of the type within the organization. - `displayname` (string, required) — Name shown to users. - `hierarchical` (boolean, optional, default: true) — Whether categories of this type can be nested under a parent. - `system` (boolean, optional, default: false) — Marks a built-in type, which cannot be renamed or deleted. - `closed` (boolean, optional, default: false) — Whether new top-level categories are blocked for this type. - `relationtype` (integer, optional, default: 0) — How many categories of this type one term may carry: `0` at least one, `1` zero or more, `2` exactly one, `3` at most one. - `membershaveseparatedisplayname` (boolean, optional, default: true) — Whether this type's categories may have a display name that differs from their name. ## Response ### 201 Successful Response - `id` (string, required) — Identifier used by this API. - `name` (string, required) — Unique name; ACTIF documents refer to it. - `displayname` (string, required) - `hierarchical` (boolean, required) - `system` (boolean, required) — Built-in types cannot be renamed or deleted. - `closed` (boolean, required) - `relationtype` (integer, required) — How many categories of this type one term may carry: `0` at least one, `1` zero or more, `2` exactly one, `3` at most one. - `membershaveseparatedisplayname` (boolean, required) - `uuid` (string, required) — Stable identifier carried over from Acrolinx terminology. - `external_id` (string, required) — External identifier; built-in types use the Acrolinx system identifier, for example `com.acrolinx.api.category.SystemCategoryTypeIdentifier.DOMAIN`. - `category_count` (integer, optional, default: 0) — Number of categories of this type. ## Errors ### 401 Unauthorized Error Authentication failed or no valid API key provided. - `detail` (string, required) — A description of the error that occurred. - `status` (integer, required) — The HTTP status code generated by the server for this issue - `request_id` (string, required) — A unique ID associated with the HTTP request. ### 403 Forbidden Error Forbidden - `detail` (string, required) — A description of the error that occurred. - `status` (integer, required) — The HTTP status code generated by the server for this issue - `request_id` (string, required) — A unique ID associated with the HTTP request. ### 422 Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ### 500 Internal Server Error Internal Server Error - `detail` (string, required) — A description of the error that occurred. - `status` (integer, required) — The HTTP status code generated by the server for this issue - `request_id` (string, required) — A unique ID associated with the HTTP request. ## Types ### ValidationError - `loc` (list of ValidationErrorLocItems, required) - `msg` (string, required) - `type` (string, required) - `input` (any, optional) - `ctx` (ValidationErrorCtx, optional) ### ValidationErrorLocItems - string - integer ### ValidationErrorCtx ## Examples **Request** ```json { "name": "string", "displayname": "string" } ``` **Response** ```json { "id": "string", "name": "string", "displayname": "string", "hierarchical": true, "system": true, "closed": true, "relationtype": 1, "membershaveseparatedisplayname": true, "uuid": "string", "external_id": "string", "category_count": 0 } ``` **SDK Code** ```python import requests url = "https://api.markup.ai/style-agent/terminology/category-types" payload = { "name": "string", "displayname": "string" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.markup.ai/style-agent/terminology/category-types'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"string","displayname":"string"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.markup.ai/style-agent/terminology/category-types" payload := strings.NewReader("{\n \"name\": \"string\",\n \"displayname\": \"string\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.markup.ai/style-agent/terminology/category-types") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"string\",\n \"displayname\": \"string\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.markup.ai/style-agent/terminology/category-types") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"string\",\n \"displayname\": \"string\"\n}") .asString(); ``` ```php request('POST', 'https://api.markup.ai/style-agent/terminology/category-types', [ 'body' => '{ "name": "string", "displayname": "string" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.markup.ai/style-agent/terminology/category-types"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"string\",\n \"displayname\": \"string\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "name": "string", "displayname": "string" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.markup.ai/style-agent/terminology/category-types")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```