API Reference
Build with ❤️
Interactive documentation for every public endpoint. Authenticate with the
x-api-key header or the apikey query parameter,
tweak the request, and press Send to run it live against your chosen environment.
Query Parameters Copy
json
{
"url": "https://www.gsmarena.com/apple_iphone_15_pro_max-12597.php"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"results": {
"title": "Apple iPhone 15 Pro Max",
"releaseDate": "2023, Sep 22",
"dimensions": "159.9 x 76.7 x 8.3 mm",
"displayInfo": "LTPO Super Retina XDR OLED",
"chipsetInfo": "Apple A17 Pro (3 nm)",
"storage": "256GB/512GB/1TB",
"spec_detail": [ ... ]
}
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"query": "iphone 15"
}
Example Response Copy
200 OK · json
{
"success": true,
"results": [
{ "name": "Apple iPhone 15 Pro Max", "url": "https://www.gsmarena.com/apple_iphone_15_pro_max-12597.php" },
{ "name": "Apple iPhone 15 Pro", "url": "..." }
]
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"query": "What is the capital of France?",
"UID": "user123"
}
Example Response Copy
200 OK · json
{
"response": {
"message": "The capital of France is Paris.",
"imageUrls": []
},
"author": "Rishad"
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
GET
/api/blackbox
API Key
Chat with Blackbox AI. Maintains conversation history per uid. Send "clear" as query to reset.
Query Parameters Copy
json
{
"uid": "user123",
"query": "Hello!"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"uid": "user123",
"result": "Hello! How can I help you today?"
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"uid": "user123",
"query": "Tell me a joke"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"uid": "user123",
"result": "Why did the chicken cross the road?"
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"message": "Hello!"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"message": "Hello!",
"reply": "Hi there! How are you?"
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"question": "What is your name?",
"answer": "My name is SimSimi!"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"message": "Taught "What is your name?" → "My name is SimSimi!""
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"uid": "user123",
"query": "Tell me about yourself"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"result": ["Hello! I'm Pi, your personal AI assistant."],
"uid": "user123",
"voiceURLs": [ "https://pi.ai/api/chat/voice?...", ... ]
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
GET
/api/cai/chat
API Key
Chat with a Character.AI character by character ID (cid). Maintains conversation history per uid per character.
Query Parameters Copy
json
{
"uid": "user123",
"query": "Hello!",
"cid": "char_id_here"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"result": "Hello! I'm your character.",
"uid": "user123"
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"name": "Elon Musk"
}
Example Response Copy
200 OK · json
{
"status": "success",
"result": [
{
"name": "Elon Musk",
"title": "CEO of Tesla & SpaceX",
"character_id": "abc123",
"avatar": "https://characterai.io/i/400/static/avatars/..."
}
]
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"url": "https://www.tiktok.com/@user/video/123456"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"result": {
"title": "Video title",
"user": "@username",
"watermark": "https://...",
"no_watermark": "https://...",
"audio": "https://..."
}
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
GET
/api/tiktok/search
API Key
Search TikTok videos by keyword with configurable result count (1–50).
Query Parameters Copy
json
{
"query": "funny cats",
"count": 10
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"count": 10,
"results": [
{
"title": "Funny Cats Compilation",
"cover": "https://...",
"no_watermark": "https://...",
"views": 123456,
"like": 7890
}
]
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
"format": "mp4",
"quality": "1080"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"title": "Rick Astley - Never Gonna Give You Up",
"quality": "1080 (320kbps)",
"channel": "Rick Astley",
"downloadLink": "https://..."
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
GET
/api/youtube/search
API Key
Search YouTube videos by keyword. Returns detailed results including thumbnails and durations.
Query Parameters Copy
json
{
"query": "lofi hip hop"
}
Example Response Copy
200 OK · json
{
"success": true,
"data": [
{
"id": "videoId",
"title": "lofi hip hop radio",
"duration": "3:45",
"viewCount": 12345678,
"thumbnail": "https://..."
}
]
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"url": "https://www.instagram.com/p/abc123/"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"results": {
"media": [ "https://..." ],
"thumbnail": "https://...",
"title": "Post caption",
"username": "@user",
"likes": 123
}
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"query": "wallpaper"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"result": {
"count": { "images": 25, "videos": 3 },
"images": [ "https://i.pinimg.com/..." ],
"videos": [ "https://v.pinimg.com/..." ]
}
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"url": "https://www.facebook.com/watch?v=123"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"title": "Video title",
"uploader": "Page Name",
"duration": 120,
"thumbnail": "https://...",
"url": "https://..."
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"imageUrl": "https://example.com/image.jpg"
}
Example Response Copy
200 OK · json
{
"success": true,
"status": "success",
"isNsfw": false,
"label": "sfw",
"confidence": 0.9876,
"percentage": "98.76%",
"message": "✅ Image is safe (SFW)."
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"imageUrl": "https://example.com/image.jpg"
}
Example Response Copy
200 OK · json
(binary PNG image data)
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"imageUrl": "https://example.com/image.jpg"
}
Example Response Copy
200 OK · json
(binary PNG image data)
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"url": "https://example.com/file.mp4"
}
Example Response Copy
200 OK · json
(raw streamed response)
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"imageUrl": "https://example.com/photo.jpg"
}
Example Response Copy
200 OK · json
(binary PNG image data)
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"imageUrl": "https://example.com/photo.jpg"
}
Example Response Copy
200 OK · json
(binary PNG image data)
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Example Response Copy
200 OK · json
{
"success": true,
"data": {
"animes": [ ... ]
}
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"id": "anime-id-123"
}
Example Response Copy
200 OK · json
{
"success": true,
"data": {
"name": "One Piece",
"episodes": [...],
"recommendations": [...]
}
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"id": "anime-id-123"
}
Example Response Copy
200 OK · json
{
"success": true,
"data": {
"episodes": [ ... ],
"totalEpisodes": 1000
}
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"episode": "episode-id-456"
}
Example Response Copy
200 OK · json
{
"success": true,
"data": [ ... ]
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Query Parameters Copy
json
{
"episode": "episode-id-456",
"server": "hd-1",
"lang": "sub"
}
Example Response Copy
200 OK · json
{
"success": true,
"data": {
"sources": [ ... ],
"subtitles": [ ... ]
}
}
Try it
Headers
Params
No response yet — press Send Request to run this endpoint live.
Get started in 30 seconds
Grab a free API key — 5,000 requests per day, no credit card required.
Get Your API Key →