Authentication
Authenticate requests with your API key using the following HTTP header.
Authorization: Bearer <YOUR_KEY>API access requires a paid workspace. Calls are billed by usage.
POST/api/openapi/v1/creators/detailCreator details
API pricing0.1 credits / successful request
Cart check: 0.2 credits / successful request, including unknown results. Failures are refunded.
Supported platformsInstagram / YouTube / TikTok / Twitter / X
Quick start (cURL)
curl -X POST 'https://app.hicreator.ai/api/openapi/v1/creators/detail' \
-H 'Authorization: Bearer <YOUR_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"profile_url": "https://www.instagram.com/example_creator/"
}'Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| profile_url | string | Yes | Creator profile link. |
| include_video_cart | boolean | No | Check TikTok cart tags; off by default. |
Response fields
| Parameter | Type | Always returned | Description |
|---|---|---|---|
| requestId | string | Yes | Request ID for support. |
| billingRequestId | string | Yes | Billing record ID. |
| data | object | Yes | Query result. |
| data.platform | 'instagram' | Yes | Platform. |
| data.canonicalUrl | string (URL) | Yes | Profile or content link. |
| data.retrievedAt | string (ISO 8601) | Yes | Retrieved at. |
| data.creator | object | Yes | Creator profile. |
| data.creator.id | string | Yes | Platform creator ID. |
| data.creator.username | string | No | Handle. |
| data.creator.displayName | string | No | Display name. |
| data.creator.biography | string | No | Biography. |
| data.creator.avatarUrl | string (URL) | No | Avatar link. |
| data.creator.followerCount | integer | No | Followers or subscribers. |
| data.creator.verified | boolean | No | Verified account. |
| data.creator.privateAccount | boolean | No | Private account. |
| data.creator.platformDetails | object | Yes | Platform-specific details. |
| data.creator.platformDetails.followingCount | integer | No | Accounts followed. |
| data.creator.platformDetails.mediaCount | integer | No | Total posts. |
| data.creator.platformDetails.businessAccount | boolean | No | Business account. |
| data.creator.platformDetails.category | string | No | Creator category. |
| data.creator.platformDetails.externalUrl | string (URL) | No | Profile external link. |
Example response (JSON)
{
"requestId": "<request-id>",
"billingRequestId": "<billing-request-id>",
"data": {
"platform": "instagram",
"canonicalUrl": "https://www.instagram.com/example_creator/",
"retrievedAt": "2026-09-28T01:02:03.000Z",
"creator": {
"id": "<creator-id>",
"username": "example_creator",
"displayName": "Example Creator",
"biography": "Travel creator",
"avatarUrl": "https://example.com/avatar.jpg",
"verified": true,
"privateAccount": false,
"followerCount": 50000,
"platformDetails": {
"followingCount": 300,
"mediaCount": 120,
"businessAccount": true,
"category": "Travel Creator",
"externalUrl": "https://example.com/"
}
}
}
}Errors and retries
See error.message; keep requestId for support. Do not retry uncertain requests.
View error codes
Request: 400 invalid parameters (10001) or quantity below the minimum (70004); 401 invalid key (20001); 403 API access is only available to paid Workspaces (60006); 413 payload too large (10005); 415 unsupported format (10006); 429 too many requests (10007).
Execution: 404 Twitter creator unavailable (60008); 422 invalid search intent (60001) or target account (60002); 422 email lookup incomplete (60009): search limits reached, fully refunded; this does not mean no email exists and must not be automatically retried; 502 email lookup failed (60003) or execution failed (60004); 504 request timed out (60005). Gateway error pages are returned as JSON with code API_UPSTREAM_ERROR; do not automatically retry paid requests.
Credits: 402 insufficient balance (70001) or daily limit exceeded (70006); 409 feature unavailable (70002) or credit record conflict (70003). API errors include error.code, error.message, and error.requestId. Business errors include error.billingRequestId after charging starts; gateway fallbacks may lack it and cannot confirm refund status.