Add a tag to a document

curl --request POST \
  --url https://api.example.com/v1/knowledge/documents/{doc_id}/tags \
  --header 'Content-Type: application/json' \
  --data '
{
  "tag": "politicas",
  "status": "suggested",
  "source": "manual"
}
'

import requests

url = "https://api.example.com/v1/knowledge/documents/{doc_id}/tags"

payload = {
    "tag": "politicas",
    "status": "suggested",
    "source": "manual"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({tag: 'politicas', status: 'suggested', source: 'manual'})
};

fetch('https://api.example.com/v1/knowledge/documents/{doc_id}/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.example.com/v1/knowledge/documents/{doc_id}/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' => 'politicas',
    'status' => 'suggested',
    'source' => 'manual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/v1/knowledge/documents/{doc_id}/tags"

	payload := strings.NewReader("{\n  \"tag\": \"politicas\",\n  \"status\": \"suggested\",\n  \"source\": \"manual\"\n}")

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

	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.example.com/v1/knowledge/documents/{doc_id}/tags")
  .header("Content-Type", "application/json")
  .body("{\n  \"tag\": \"politicas\",\n  \"status\": \"suggested\",\n  \"source\": \"manual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/knowledge/documents/{doc_id}/tags")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tag\": \"politicas\",\n  \"status\": \"suggested\",\n  \"source\": \"manual\"\n}"

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

{
  "id": 123,
  "doc_id": "<string>",
  "tag": "<string>",
  "status": "<string>",
  "source": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

knowledge

documents

{doc_id}

tags

Add a tag to a document

curl --request POST \
  --url https://api.example.com/v1/knowledge/documents/{doc_id}/tags \
  --header 'Content-Type: application/json' \
  --data '
{
  "tag": "politicas",
  "status": "suggested",
  "source": "manual"
}
'

import requests

url = "https://api.example.com/v1/knowledge/documents/{doc_id}/tags"

payload = {
    "tag": "politicas",
    "status": "suggested",
    "source": "manual"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({tag: 'politicas', status: 'suggested', source: 'manual'})
};

fetch('https://api.example.com/v1/knowledge/documents/{doc_id}/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.example.com/v1/knowledge/documents/{doc_id}/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' => 'politicas',
    'status' => 'suggested',
    'source' => 'manual'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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.example.com/v1/knowledge/documents/{doc_id}/tags"

	payload := strings.NewReader("{\n  \"tag\": \"politicas\",\n  \"status\": \"suggested\",\n  \"source\": \"manual\"\n}")

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

	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.example.com/v1/knowledge/documents/{doc_id}/tags")
  .header("Content-Type", "application/json")
  .body("{\n  \"tag\": \"politicas\",\n  \"status\": \"suggested\",\n  \"source\": \"manual\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/knowledge/documents/{doc_id}/tags")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tag\": \"politicas\",\n  \"status\": \"suggested\",\n  \"source\": \"manual\"\n}"

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

{
  "id": 123,
  "doc_id": "<string>",
  "tag": "<string>",
  "status": "<string>",
  "source": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Path Parameters

doc_id

string

required

Body

application/json

Request body for POST /knowledge/documents/{doc_id}/tags.

tag

string

required

Tag string to add to the document.

Required string length: 1 - 256

Examples:

"politicas"

"sla"

"enterprise"

status

string

default:suggested

Initial status: 'suggested' | 'confirmed' | 'rejected'.

source

string

default:manual

Tag origin: 'auto' | 'manual'.

Response

Tag created

A single tag record.

integer

required

doc_id

string

required

tag

string

required

status

string

required

'suggested' | 'confirmed' | 'rejected'

source

string

required

'auto' | 'manual'

created_at

string | null

updated_at

string | null

Visão Geral

Memory API

Knowledge API

Catalog API

Skills API

MCP Server

Add a tag to a document

Path Parameters

Body

Response