Bulk save tag definitions

Create or update tag definitions, preserving unspecified slots. Updates require originalDisplayName; other entries create tags. Slot and name conflicts appear in per-definition errors with HTTP 200, leaving conflicting values unchanged. Use Update document to set tag values. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:write.

PUT/api/v2/knowledge/{knowledgeBaseId}/tags

Authorization

X-API-Key<token>

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

In: header

Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.

curl -X PUT "https://www.sim.ai/api/v2/knowledge/string/tags" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "definitions": [      {        "tagSlot": "tag1",        "displayName": "category",        "fieldType": "text"      }    ]  }'
const body = JSON.stringify({  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "definitions": [    {      "tagSlot": "tag1",      "displayName": "category",      "fieldType": "text"    }  ]})fetch("https://www.sim.ai/api/v2/knowledge/string/tags", {  method: "PUT",  headers: {    "Content-Type": "application/json",    "X-API-Key": "YOUR_API_KEY"  },  body})
package mainimport (  "fmt"  "net/http"  "io/ioutil"  "strings")func main() {  url := "https://www.sim.ai/api/v2/knowledge/string/tags"  body := strings.NewReader(`{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "definitions": [      {        "tagSlot": "tag1",        "displayName": "category",        "fieldType": "text"      }    ]  }`)  req, _ := http.NewRequest("PUT", url, body)  req.Header.Add("X-API-Key", "YOUR_API_KEY")  req.Header.Add("Content-Type", "application/json")  res, _ := http.DefaultClient.Do(req)  defer res.Body.Close()  body, _ := ioutil.ReadAll(res.Body)  fmt.Println(res)  fmt.Println(string(body))}
import requestsurl = "https://www.sim.ai/api/v2/knowledge/string/tags"body = """{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "definitions": [    {      "tagSlot": "tag1",      "displayName": "category",      "fieldType": "text"    }  ]}"""response = requests.request("PUT", url, data = body, headers = {  "Content-Type": "application/json",   "X-API-Key": "YOUR_API_KEY"})print(response.text)
import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "definitions": [    {      "tagSlot": "tag1",      "displayName": "category",      "fieldType": "text"    }  ]}""");HttpClient client = HttpClient.newBuilder()  .connectTimeout(Duration.ofSeconds(10))  .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()  .uri(URI.create("https://www.sim.ai/api/v2/knowledge/string/tags"))  .header("X-API-Key", "YOUR_API_KEY")  .header("Content-Type", "application/json")  .PUT(body)  .build();try {  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());  System.out.println("Status code: " + response.statusCode());  System.out.println("Response body: " + response.body());} catch (Exception e) {  e.printStackTrace();}
using System;using System.Net.Http;using System.Text;var body = new StringContent("""{  "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",  "definitions": [    {      "tagSlot": "tag1",      "displayName": "category",      "fieldType": "text"    }  ]}""", Encoding.UTF8, "application/json");var client = new HttpClient();client.DefaultRequestHeaders.Add("X-API-Key", "YOUR_API_KEY");var response = await client.PutAsync("https://www.sim.ai/api/v2/knowledge/string/tags", body);var responseBody = await response.Content.ReadAsStringAsync();
{
  "data": {
    "created": [
      {
        "id": "string",
        "displayName": "category",
        "tagSlot": "tag1",
        "fieldType": "text"
      }
    ],
    "updated": [
      {
        "id": "string",
        "displayName": "category",
        "tagSlot": "tag1",
        "fieldType": "text"
      }
    ],
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}

Path parameters

knowledgeBaseId*string

Unique knowledge base identifier.

Length1 <= length

Request body

application/json

Workspace scope and the tag definitions to create or update.

TypeScript definitions

Use the request body type in TypeScript.

Response body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

POSTIndex workspace filesPATCHBulk update chunks