Skip to main content
POST
/
v1
/
categories
/
search
Media Categories Search
curl --request POST \
  --url https://api.upriver.ai/v1/categories/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "text": "<string>",
  "top_k": 5
}
'
import requests

url = "https://api.upriver.ai/v1/categories/search"

payload = {
    "text": "<string>",
    "top_k": 5
}
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({text: '<string>', top_k: 5})
};

fetch('https://api.upriver.ai/v1/categories/search', 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.upriver.ai/v1/categories/search",
  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([
    'text' => '<string>',
    'top_k' => 5
  ]),
  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.upriver.ai/v1/categories/search"

	payload := strings.NewReader("{\n  \"text\": \"<string>\",\n  \"top_k\": 5\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.upriver.ai/v1/categories/search")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"<string>\",\n  \"top_k\": 5\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.upriver.ai/v1/categories/search")

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  \"text\": \"<string>\",\n  \"top_k\": 5\n}"

response = http.request(request)
puts response.read_body
{
  "matches": [
    {
      "category_id": "<string>",
      "display_name": "<string>",
      "level": 123,
      "confidence": 0.5,
      "parent_id": "<string>",
      "reason": "<string>"
    }
  ],
  "query_text": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Search parameters

​
text
string
required

Freeform text to match against category taxonomy

Example:

"telehealth and men's health"

​
top_k
integer
default:5

Number of categories to return, ordered by relevance

Required range: 1 <= x <= 20

Response

Successful Response

Response from category search endpoint.

​
matches
CategoryMatch · object[]
required

Ordered list of matched categories (highest confidence first)

​
query_text
string
required

The input text that was matched