curl --request GET \
--url https://backend.clipvision.ai/api/user/ \
--header 'Authorization: Basic <encoded-value>'{
"user_id": 1,
"stripe_customer_id": "cus_123",
"plan_id": 1,
"disabled": false,
"username": "Test User",
"avatar_url": "https://www.test.com/avatar.jpg",
"avg_credits_per_video_weekly": 1,
"avg_credits_per_video_monthly": 1,
"avg_credits_per_video_yearly": 1,
"avg_credits_per_video_increase_weekly": 0,
"avg_credits_per_video_increase_monthly": 0,
"avg_credits_per_video_increase_yearly": 0,
"total_credits": 0,
"total_videos": 1,
"created_videos_increase_weekly": 0,
"created_videos_increase_monthly": 0,
"created_videos_increase_yearly": 0,
"total_font_profiles": 1,
"total_media_profiles": 1,
"total_voice_profiles": 1,
"total_playlists": 1,
"total_limitations": 1,
"total_voices": 1,
"settings": {
"plan": {
"subscription_start": "2021-01-01T00:00:00.000Z",
"subscription_end": "2021-02-01T00:00:00.000Z",
"subscription_visualizer": "Default",
"subscription_credits": 0,
"subscription_price": 0,
"can_upgrade": false,
"can_downgrade": false,
"can_add_credits": false,
"expired": true,
"remaining_time": "-3yrs left",
"stripe_subscription_id": "sub_123",
"disabled": false
},
"credits": [
{
"id": 1,
"disabled": false,
"value": 100,
"creation_date": "2021-01-01T00:00:00.000Z",
"expiration_date": "2021-03-01T00:00:00.000Z",
"expired": true
}
],
"email_address": "[email protected]",
"secret_key": "testSecretKey",
"azure_data": {
"api_key": "",
"region": "eastus"
},
"elevenlabs_api_key": "",
"discord_webhook": "https://discord.com/webhooks/ClipVision",
"last_added": {
"id": 1,
"disabled": false,
"value": 100,
"creation_date": "2021-01-01T00:00:00.000Z",
"expiration_date": "2021-03-01T00:00:00.000Z",
"expired": true
}
},
"font_profiles": [
{
"font_profile_id": 1,
"disabled": false,
"profile_name": "New Font Profile",
"name": "Poppins",
"path": "Poppins",
"size": 30,
"bold": false,
"italic": false,
"underlined": false,
"strikethrough": false,
"caption_position": {
"coordinate_id": 0,
"overlay_visualizer": "Middle Center",
"x": "(main_w-overlay_w)/2",
"y": "(main_h-overlay_h)/2"
},
"caption_style_color": "#FFFFFF",
"caption_style_stroke_color": "#000000",
"caption_style_stroke_thickness": 2,
"caption_shadow_x_pos": 16,
"caption_shadow_y_pos": 14,
"caption_shadow_color": "#000000",
"caption_shadow_blur": 6,
"caption_lines": 1,
"caption_ai_keyword_highlighter": false,
"caption_ai_keyword_highlighter_color": "#80B8FF",
"caption_highlighter": true,
"caption_highlighter_color": "#FFFF00",
"preview_url": null
}
],
"media_profiles": [
{
"media_profile_id": 1,
"disabled": false,
"profile_name": "New Media Profile",
"watermark_path": null,
"watermark_position": null,
"end_clip_path": null,
"preview_url": null
}
],
"voice_profiles": [
{
"voice_profile_id": 1,
"disabled": false,
"profile_name": "New Voice Profile",
"api_key": "api_key",
"region": "westus2",
"provider_id": "elevenlabs",
"provider_name": "ElevenLabs"
}
],
"playlists": [
{
"playlist_id": 1,
"disabled": false,
"playlist_name": "Playlist #1",
"font_profile": {
"font_profile_id": 1,
"disabled": false,
"profile_name": "New Font Profile",
"name": "Poppins",
"path": "Poppins",
"size": 30,
"bold": false,
"italic": false,
"underlined": false,
"strikethrough": false,
"caption_position": {
"coordinate_id": 0,
"overlay_visualizer": "Middle Center",
"x": "(main_w-overlay_w)/2",
"y": "(main_h-overlay_h)/2"
},
"caption_style_color": "#FFFFFF",
"caption_style_stroke_color": "#000000",
"caption_style_stroke_thickness": 2,
"caption_shadow_x_pos": 16,
"caption_shadow_y_pos": 14,
"caption_shadow_color": "#000000",
"caption_shadow_blur": 6,
"caption_lines": 1,
"caption_ai_keyword_highlighter": false,
"caption_ai_keyword_highlighter_color": "#80B8FF",
"caption_highlighter": true,
"caption_highlighter_color": "#FFFF00",
"preview_url": null
},
"media_profile": {
"media_profile_id": 1,
"disabled": false,
"profile_name": "New Media Profile",
"watermark_path": null,
"watermark_position": null,
"end_clip_path": null,
"preview_url": null
},
"voice_profile": {
"voice_profile_id": 1,
"disabled": false,
"profile_name": "New Voice Profile",
"api_key": "api_key",
"region": "westus2",
"provider_id": "elevenlabs",
"provider_name": "ElevenLabs"
},
"content_type": {
"content_type_id": 1,
"display_name": "Default Model (DM)",
"model_id": "dm-1.0",
"description": "Default model for video creation.",
"preview_image": "",
"preview_video": "",
"active": true
},
"preview_url": ""
}
],
"limitations": [
{
"id": 0,
"enabled": true
}
],
"voices": [
{
"voice_id": 1,
"disabled": false,
"user_id": 1,
"voice_profile_id": 1,
"voice_name": "Test Voice",
"provider_voice_id": "test_voice_id",
"voice_profile": null
}
],
"videos": [
{
"video_id": 1,
"disabled": false,
"video_title": "Video Title",
"video_description": "Video Description",
"elapsed_gen_time": 100,
"credits_cost": 1,
"resolution": "1920x1080",
"creation_date": "2024-03-17T17:48:20.000Z",
"original_input_script": "Original Input Script",
"download_link": "https://clipvision.ai/download/video/1",
"preview_url": "https://clipvision.ai/preview/video/1",
"content_type": null,
"input_video": null,
"input_music": null,
"input_voice": null,
"font_profile": null,
"media_profile": null,
"voice_profile": null,
"template": null,
"playlist": null
}
]
}This API endpoint allows a user to retrieve their data.
curl --request GET \
--url https://backend.clipvision.ai/api/user/ \
--header 'Authorization: Basic <encoded-value>'{
"user_id": 1,
"stripe_customer_id": "cus_123",
"plan_id": 1,
"disabled": false,
"username": "Test User",
"avatar_url": "https://www.test.com/avatar.jpg",
"avg_credits_per_video_weekly": 1,
"avg_credits_per_video_monthly": 1,
"avg_credits_per_video_yearly": 1,
"avg_credits_per_video_increase_weekly": 0,
"avg_credits_per_video_increase_monthly": 0,
"avg_credits_per_video_increase_yearly": 0,
"total_credits": 0,
"total_videos": 1,
"created_videos_increase_weekly": 0,
"created_videos_increase_monthly": 0,
"created_videos_increase_yearly": 0,
"total_font_profiles": 1,
"total_media_profiles": 1,
"total_voice_profiles": 1,
"total_playlists": 1,
"total_limitations": 1,
"total_voices": 1,
"settings": {
"plan": {
"subscription_start": "2021-01-01T00:00:00.000Z",
"subscription_end": "2021-02-01T00:00:00.000Z",
"subscription_visualizer": "Default",
"subscription_credits": 0,
"subscription_price": 0,
"can_upgrade": false,
"can_downgrade": false,
"can_add_credits": false,
"expired": true,
"remaining_time": "-3yrs left",
"stripe_subscription_id": "sub_123",
"disabled": false
},
"credits": [
{
"id": 1,
"disabled": false,
"value": 100,
"creation_date": "2021-01-01T00:00:00.000Z",
"expiration_date": "2021-03-01T00:00:00.000Z",
"expired": true
}
],
"email_address": "[email protected]",
"secret_key": "testSecretKey",
"azure_data": {
"api_key": "",
"region": "eastus"
},
"elevenlabs_api_key": "",
"discord_webhook": "https://discord.com/webhooks/ClipVision",
"last_added": {
"id": 1,
"disabled": false,
"value": 100,
"creation_date": "2021-01-01T00:00:00.000Z",
"expiration_date": "2021-03-01T00:00:00.000Z",
"expired": true
}
},
"font_profiles": [
{
"font_profile_id": 1,
"disabled": false,
"profile_name": "New Font Profile",
"name": "Poppins",
"path": "Poppins",
"size": 30,
"bold": false,
"italic": false,
"underlined": false,
"strikethrough": false,
"caption_position": {
"coordinate_id": 0,
"overlay_visualizer": "Middle Center",
"x": "(main_w-overlay_w)/2",
"y": "(main_h-overlay_h)/2"
},
"caption_style_color": "#FFFFFF",
"caption_style_stroke_color": "#000000",
"caption_style_stroke_thickness": 2,
"caption_shadow_x_pos": 16,
"caption_shadow_y_pos": 14,
"caption_shadow_color": "#000000",
"caption_shadow_blur": 6,
"caption_lines": 1,
"caption_ai_keyword_highlighter": false,
"caption_ai_keyword_highlighter_color": "#80B8FF",
"caption_highlighter": true,
"caption_highlighter_color": "#FFFF00",
"preview_url": null
}
],
"media_profiles": [
{
"media_profile_id": 1,
"disabled": false,
"profile_name": "New Media Profile",
"watermark_path": null,
"watermark_position": null,
"end_clip_path": null,
"preview_url": null
}
],
"voice_profiles": [
{
"voice_profile_id": 1,
"disabled": false,
"profile_name": "New Voice Profile",
"api_key": "api_key",
"region": "westus2",
"provider_id": "elevenlabs",
"provider_name": "ElevenLabs"
}
],
"playlists": [
{
"playlist_id": 1,
"disabled": false,
"playlist_name": "Playlist #1",
"font_profile": {
"font_profile_id": 1,
"disabled": false,
"profile_name": "New Font Profile",
"name": "Poppins",
"path": "Poppins",
"size": 30,
"bold": false,
"italic": false,
"underlined": false,
"strikethrough": false,
"caption_position": {
"coordinate_id": 0,
"overlay_visualizer": "Middle Center",
"x": "(main_w-overlay_w)/2",
"y": "(main_h-overlay_h)/2"
},
"caption_style_color": "#FFFFFF",
"caption_style_stroke_color": "#000000",
"caption_style_stroke_thickness": 2,
"caption_shadow_x_pos": 16,
"caption_shadow_y_pos": 14,
"caption_shadow_color": "#000000",
"caption_shadow_blur": 6,
"caption_lines": 1,
"caption_ai_keyword_highlighter": false,
"caption_ai_keyword_highlighter_color": "#80B8FF",
"caption_highlighter": true,
"caption_highlighter_color": "#FFFF00",
"preview_url": null
},
"media_profile": {
"media_profile_id": 1,
"disabled": false,
"profile_name": "New Media Profile",
"watermark_path": null,
"watermark_position": null,
"end_clip_path": null,
"preview_url": null
},
"voice_profile": {
"voice_profile_id": 1,
"disabled": false,
"profile_name": "New Voice Profile",
"api_key": "api_key",
"region": "westus2",
"provider_id": "elevenlabs",
"provider_name": "ElevenLabs"
},
"content_type": {
"content_type_id": 1,
"display_name": "Default Model (DM)",
"model_id": "dm-1.0",
"description": "Default model for video creation.",
"preview_image": "",
"preview_video": "",
"active": true
},
"preview_url": ""
}
],
"limitations": [
{
"id": 0,
"enabled": true
}
],
"voices": [
{
"voice_id": 1,
"disabled": false,
"user_id": 1,
"voice_profile_id": 1,
"voice_name": "Test Voice",
"provider_voice_id": "test_voice_id",
"voice_profile": null
}
],
"videos": [
{
"video_id": 1,
"disabled": false,
"video_title": "Video Title",
"video_description": "Video Description",
"elapsed_gen_time": 100,
"credits_cost": 1,
"resolution": "1920x1080",
"creation_date": "2024-03-17T17:48:20.000Z",
"original_input_script": "Original Input Script",
"download_link": "https://clipvision.ai/download/video/1",
"preview_url": "https://clipvision.ai/preview/video/1",
"content_type": null,
"input_video": null,
"input_music": null,
"input_voice": null,
"font_profile": null,
"media_profile": null,
"voice_profile": null,
"template": null,
"playlist": null
}
]
}Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Successfully retrieved the user data
User OpenAPI Schema
Settings OpenAPI Schema
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes