Skip to main content
POST
/
v1
/
creators
/
batch
Batch Creator Details
curl --request POST \
  --url https://api.upriver.ai/v1/creators/batch \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "urls": [
    "<string>"
  ]
}
'
import requests

url = "https://api.upriver.ai/v1/creators/batch"

payload = { "urls": ["<string>"] }
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({urls: ['<string>']})
};

fetch('https://api.upriver.ai/v1/creators/batch', 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/creators/batch",
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([
'urls' => [
'<string>'
]
]),
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/creators/batch"

payload := strings.NewReader("{\n \"urls\": [\n \"<string>\"\n ]\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/creators/batch")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"urls\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.upriver.ai/v1/creators/batch")

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 \"urls\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "url": "<string>",
      "channels": [
        {
          "platform": "<string>",
          "handle": "<string>",
          "url": "<string>",
          "platform_id": "UCBcRF18a7Qf58cCRy5xuWwQ",
          "display_name": "MrBeast",
          "channel_relationship": "attached",
          "profile_pic_url": "https://yt3.ggpht.com/...",
          "subscriber_count": 4227,
          "subscriber_count_text": "4.2K",
          "follower_bucket": {
            "id": "<string>",
            "display": "<string>",
            "min_followers": 1,
            "max_followers": 49999
          },
          "engagement_metrics": {
            "avg_views": 125000,
            "avg_likes": 5000,
            "avg_comments": 500,
            "avg_engagement_rate": 0.05
          },
          "video_metrics": {
            "avg_duration_seconds": 615,
            "lookback_weeks": 12,
            "pct_over_8m": 66.7,
            "uploads_per_week": 1.75,
            "weeks_observed": 12,
            "window_complete": true
          },
          "relative_metrics": {
            "engagement": {
              "benchmark_basis": {
                "platform": "<string>",
                "follower_bucket_id": "<string>",
                "benchmark_date": "<string>",
                "content_category": {
                  "id": "<string>",
                  "name": "<string>"
                }
              },
              "avg_views": {},
              "avg_engagement_rate": {}
            }
          }
        }
      ],
      "associated_creators": [
        {
          "creator_id": "<string>"
        }
      ],
      "labels": [
        {
          "id": "<string>",
          "name": "<string>",
          "level": 1,
          "parent_id": "beauty"
        }
      ],
      "tags": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "creator_id": "<string>",
      "error": "<string>"
    }
  ],
  "successful_count": 123,
  "failed_count": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Input payload for batch creator lookup.

urls
string[]
required

Known social media profile URLs for the creators. Example: https://youtube.com/@handle

Required array length: 1 - 10 elements
Example:
[
"https://youtube.com/@MrBeast",
"https://youtube.com/@MKBHD",
"https://youtube.com/@CelineDept"
]

Response

Successful Response

Response for batch creator lookup.

results
CreatorBatchItemResult · object[]
required

Results for each URL in the same order as the input.

successful_count
integer
required

Number of URLs successfully resolved.

failed_count
integer
required

Number of URLs that failed to resolve.