Instantiate Taxonomy Template

curl --request POST \
  --url https://api.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "taxonomy_name": "<string>",
  "collection_config": {},
  "description": "<string>"
}
'

import requests

url = "https://api.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate"

payload = {
    "taxonomy_name": "<string>",
    "collection_config": {},
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({taxonomy_name: '<string>', collection_config: {}, description: '<string>'})
};

fetch('https://api.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate', 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.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate",
  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([
    'taxonomy_name' => '<string>',
    'collection_config' => [
        
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Namespace: <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.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate"

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

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<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.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"taxonomy_name\": \"<string>\",\n  \"collection_config\": {},\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"taxonomy_name\": \"<string>\",\n  \"collection_config\": {},\n  \"description\": \"<string>\"\n}"

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

{
  "taxonomy_id": "<string>",
  "taxonomy_name": "<string>",
  "template_id": "<string>",
  "status": "created",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

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

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

POST

templates

taxonomies

{template_id}

instantiate

Instantiate Taxonomy Template

curl --request POST \
  --url https://api.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "taxonomy_name": "<string>",
  "collection_config": {},
  "description": "<string>"
}
'

import requests

url = "https://api.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate"

payload = {
    "taxonomy_name": "<string>",
    "collection_config": {},
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({taxonomy_name: '<string>', collection_config: {}, description: '<string>'})
};

fetch('https://api.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate', 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.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate",
  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([
    'taxonomy_name' => '<string>',
    'collection_config' => [
        
    ],
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Namespace: <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.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate"

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

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<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.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"taxonomy_name\": \"<string>\",\n  \"collection_config\": {},\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/templates/taxonomies/{template_id}/instantiate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"taxonomy_name\": \"<string>\",\n  \"collection_config\": {},\n  \"description\": \"<string>\"\n}"

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

{
  "taxonomy_id": "<string>",
  "taxonomy_name": "<string>",
  "template_id": "<string>",
  "status": "created",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

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

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Authorizations

Authorization

string

header

required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace

string

header

required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

template_id

string

required

Template ID

Body

application/json

Request to instantiate a taxonomy from a template.

taxonomy_name

string

required

Name for the new taxonomy

Required string length: 1 - 100

collection_config

Collection Config · object

required

Collection configuration for the taxonomy. For flat taxonomies: {'collection_id': 'col_xxx'} For hierarchical taxonomies: maps node collection IDs to actual collection IDs, e.g., {'col_template_root': 'col_actual_root', 'col_template_child': 'col_actual_child'}

Show child attributes

description

string | null

Optional description override for the taxonomy

Maximum string length: 1000

Response

Successful Response

Response after instantiating a taxonomy template.

taxonomy_id

string

required

ID of the created taxonomy

taxonomy_name

string

required

Name of the created taxonomy

template_id

string

required

ID of the template used

status

string

default:created

Status of the instantiation

created_at

string<date-time>

Timestamp when taxonomy was created

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Events

Onboarding

Instantiate Taxonomy Template

Authorizations

Path Parameters

Body

Response