Create tag

curl --request POST \
  --url https://api.bigdata.com/contents/v1/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "tag_name": "testing tag 2"
}
'

import requests

url = "https://api.bigdata.com/contents/v1/tags"

payload = { "tag_name": "testing tag 2" }
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({tag_name: 'testing tag 2'})
};

fetch('https://api.bigdata.com/contents/v1/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://api.bigdata.com/contents/v1/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([
    'tag_name' => 'testing tag 2'
  ]),
  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://api.bigdata.com/contents/v1/tags"

	payload := strings.NewReader("{\n  \"tag_name\": \"testing tag 2\"\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://api.bigdata.com/contents/v1/tags")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tag_name\": \"testing tag 2\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/contents/v1/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  \"tag_name\": \"testing tag 2\"\n}"

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

{
  "id": "019e3a99-6952-7dd4-adf5-b0b341959e11",
  "name": "testing tag 2",
  "created_at": "2026-05-18T10:19:53.044285Z",
  "updated_at": "2026-05-18T10:19:53.044290Z",
  "file_count": 0
}

Create tag

Creates a custom tag in your organization. Use the returned id when assigning tags to a document via PATCH /contents/v1/documents/{content_id} (pass tag IDs in the tags array, not names). Tag names supplied at upload time via POST /contents/v1/documents are resolved by name; for post-upload changes, use tag IDs from this endpoint or from List tags.

If you include spaces in tag_name, they are replaced with underscores in the stored tag name. For example, testing tag 2 is stored as testing_tag_2.

POST

contents

tags

Create tag

curl --request POST \
  --url https://api.bigdata.com/contents/v1/tags \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "tag_name": "testing tag 2"
}
'

import requests

url = "https://api.bigdata.com/contents/v1/tags"

payload = { "tag_name": "testing tag 2" }
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({tag_name: 'testing tag 2'})
};

fetch('https://api.bigdata.com/contents/v1/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://api.bigdata.com/contents/v1/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([
    'tag_name' => 'testing tag 2'
  ]),
  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://api.bigdata.com/contents/v1/tags"

	payload := strings.NewReader("{\n  \"tag_name\": \"testing tag 2\"\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://api.bigdata.com/contents/v1/tags")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tag_name\": \"testing tag 2\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/contents/v1/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  \"tag_name\": \"testing tag 2\"\n}"

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

{
  "id": "019e3a99-6952-7dd4-adf5-b0b341959e11",
  "name": "testing tag 2",
  "created_at": "2026-05-18T10:19:53.044285Z",
  "updated_at": "2026-05-18T10:19:53.044290Z",
  "file_count": 0
}

Authorizations

X-API-KEY

string

header

required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Body

application/json

Request body for creating a custom tag.

tag_name

string

required

Display name for the new tag.

Example:

"testing tag 2"

Response

The created tag, including its id for use when updating document metadata.

Detailed information about a tag.

string<uuid>

required

Unique identifier for the tag.

Example:

"019a48b4-e573-7203-945a-2e7c4c164217"

name

string

required

Name of the tag (e.g. from:user@email.com, to:user@email.com, broker:Broker Name or a custom one provided by the user).

Example:

"from:user@email.com"

created_at

string<date-time>

required

Timestamp when the tag was created.

Example:

"2025-11-03T07:53:26.150858Z"

updated_at

string<date-time>

required

Timestamp when the tag was last updated.

Example:

"2025-11-03T07:53:26.150859Z"

file_count

integer

required

Number of files associated with this tag.

Example:

40

API

Knowledge Graph

Search Service

Monitors

Research Service

Content

Structured Data

Subscription

Create tag

Authorizations

Body

Response