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>"
  ]
}
'
{
  "results": [
    {
      "url": "<string>",
      "channels": [
        {
          "platform": "<string>",
          "handle": "<string>",
          "url": "<string>",
          "platform_id": "UCBcRF18a7Qf58cCRy5xuWwQ",
          "display_name": "MrBeast",
          "profile_pic_url": "https://yt3.ggpht.com/...",
          "subscriber_count": 4227,
          "subscriber_count_text": "4.2K",
          "engagement_metrics": {
            "avg_views": 125000,
            "avg_likes": 5000,
            "avg_comments": 500,
            "avg_engagement_rate": 0.05
          }
        }
      ],
      "tags": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "error": "<string>"
    }
  ],
  "successful_count": 123,
  "failed_count": 123
}

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.