Create a tag definition.

POST

tags

curl --request POST \
  --url https://{hostname}.gable.ai/v0/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "color": "<string>"
}
'

import requests

url = "https://{hostname}.gable.ai/v0/tags"

payload = {
    "name": "<string>",
    "description": "<string>",
    "color": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: '<string>', color: '<string>'})
};

fetch('https://{hostname}.gable.ai/v0/tags', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{hostname}.gable.ai/v0/tags",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'color' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{hostname}.gable.ai/v0/tags"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/tags")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/tags")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "tag": {
    "id": "<string>",
    "name": "<string>",
    "kind": "SYSTEM",
    "status": "active",
    "detection_enabled": true,
    "description": "<string>",
    "color": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  }
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

Create a tag definition. The server sets three things the caller cannot influence: kind is always USER, status is always active, and id is minted as a slug of name. Detection is off on a new tag.

name

string

required

Display name. The id is derived from it, so a name whose slug collides with an existing definition (including a SYSTEM id such as pii) is refused with 409, and one that would not form a valid id is refused with 400.

Minimum string length: 1

description

string

Optional longer explanation of what the tag means.

color

string

Optional display color for chips and badges.

Response

The created definition, carrying the minted id.

A single tag definition, as returned by create and update.

tag

object

required

One tag in the organization's vocabulary. Field tags reference it by id and the read joins it in, so a rename takes effect everywhere at once. readOnly properties are not settable on POST or PUT.

Show child attributes

⌘I

Create a tag definition.

curl --request POST \
  --url https://{hostname}.gable.ai/v0/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "color": "<string>"
}
'

import requests

url = "https://{hostname}.gable.ai/v0/tags"

payload = {
    "name": "<string>",
    "description": "<string>",
    "color": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: '<string>', color: '<string>'})
};

fetch('https://{hostname}.gable.ai/v0/tags', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{hostname}.gable.ai/v0/tags",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'color' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{hostname}.gable.ai/v0/tags"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/tags")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/tags")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "tag": {
    "id": "<string>",
    "name": "<string>",
    "kind": "SYSTEM",
    "status": "active",
    "detection_enabled": true,
    "description": "<string>",
    "color": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  }
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Introduction

Gable

Create a tag definition.

Authorizations

Body

Response