{ "info": { "name": "Genviral Partner API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Requests for testing the Partner API locally (http://localhost:3000) across personal and workspace scopes. All responses follow the ok/code/message/data envelope documented in other/docs/public/api-reference/response.mdx." }, "variable": [ { "key": "base_url", "value": "http://localhost:3000" }, { "key": "partner_api_token", "value": "gva_live_example.secret" }, { "key": "post_id", "value": "" }, { "key": "slideshow_id", "value": "" }, { "key": "pack_id", "value": "" }, { "key": "template_id", "value": "" }, { "key": "image_id", "value": "" }, { "key": "preview_id", "value": "" }, { "key": "slide_index", "value": "0" }, { "key": "video_id", "value": "" }, { "key": "folder_id", "value": "" }, { "key": "analytics_target_id", "value": "" }, { "key": "analytics_refresh_id", "value": "" } ], "item": [ { "name": "Accounts", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/accounts", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "accounts" ] }, "description": "Returns BYO + hosted accounts for the authenticated API key scope." } }, { "name": "Subscription", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/subscription", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "subscription" ] }, "description": "Returns subscription tier, credits usage, and renewal dates for the authenticated key scope." } } ] }, { "name": "Files", "item": [ { "name": "Upload", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contentType\": \"video/mp4\",\n \"filename\": \"my-video.mp4\"\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/files", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "files" ] }, "description": "Get a presigned URL to upload a file. Returns uploadUrl (for uploading) and url (CDN URL). After uploading to uploadUrl, use the url in post creation or pass it to POST /api/partner/v1/packs/{packId}/images." } }, { "name": "List", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/files?limit=20&type=video", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "files" ], "query": [ { "key": "limit", "value": "20" }, { "key": "type", "value": "video" }, { "key": "offset", "value": "0", "disabled": true }, { "key": "context", "value": "all", "disabled": true } ] }, "description": "List partner files (uploads + ingested media) in the authenticated API key scope. Optional context filter: omit for partner-only defaults, pass comma-separated contexts, or use context=all." } } ] }, { "name": "Folders", "item": [ { "name": "Collection", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders?media_type=upload&limit=20&offset=0", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders" ], "query": [ { "key": "media_type", "value": "upload" }, { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] }, "description": "List folders in key scope for one media type and hierarchy level." } }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders" ] }, "description": "Create a folder in the authenticated key scope.", "body": { "mode": "raw", "raw": "{\n \"name\": \"March Campaign\",\n \"media_type\": \"upload\"\n}" } } } ] }, { "name": "By ID", "item": [ { "name": "Get", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders/{{folder_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders", "{{folder_id}}" ] }, "description": "Fetch one folder with counts and preview metadata." } }, { "name": "Move", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders/{{folder_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders", "{{folder_id}}" ] }, "description": "Move a folder to another parent (or root with null parent_folder_id).", "body": { "mode": "raw", "raw": "{\n \"parent_folder_id\": null\n}" } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders/{{folder_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders", "{{folder_id}}" ] }, "description": "Delete a folder and its nested relations." } } ] }, { "name": "Ancestors", "item": [ { "name": "List Ancestors", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders/{{folder_id}}/ancestors", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders", "{{folder_id}}", "ancestors" ] }, "description": "Get ancestor path for breadcrumbs." } } ] }, { "name": "Items", "item": [ { "name": "List Items", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders/{{folder_id}}/items?limit=20&offset=0", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders", "{{folder_id}}", "items" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] }, "description": "List files/slideshows in one folder." } }, { "name": "Add Items", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders/{{folder_id}}/items", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders", "{{folder_id}}", "items" ] }, "description": "Attach item IDs (file IDs or slideshow IDs based on folder media type).", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"11111111-1111-1111-1111-111111111111\"\n ]\n}" } } }, { "name": "Remove Items", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/folders/{{folder_id}}/items", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "folders", "{{folder_id}}", "items" ] }, "description": "Detach item IDs from the folder.", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n \"11111111-1111-1111-1111-111111111111\"\n ]\n}" } } } ] } ] }, { "name": "Studio AI", "item": [ { "name": "Models", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/studio/models?mode=image", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "studio", "models" ], "query": [ { "key": "mode", "value": "image" } ] }, "description": "List Studio models with normalized capabilities, input contract, and params metadata." } }, { "name": "Generate Image", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"model_id\": \"google/nano-banana\",\n \"prompt\": \"A cinematic beach sunset with palm trees\",\n \"params\": {\n \"aspect_ratio\": \"16:9\",\n \"output_format\": \"jpeg\"\n }\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/studio/images/generate", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "studio", "images", "generate" ] }, "description": "Generate an image synchronously and receive hosted output URL + file_id." } }, { "name": "Generate Video", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"model_id\": \"openai/sora-2\",\n \"prompt\": \"Cinematic product reveal with soft lighting\",\n \"params\": {\n \"duration_seconds\": 5,\n \"aspect_ratio\": \"9:16\"\n }\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/studio/videos/generate", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "studio", "videos", "generate" ] }, "description": "Start async Studio video generation and receive canonical video_id for polling." } }, { "name": "Get Video Status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/studio/videos/{{video_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "studio", "videos", "{{video_id}}" ] }, "description": "Poll canonical Studio video status by video_id until succeeded/failed." } } ] }, { "name": "Posts", "item": [ { "name": "Collection", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/posts?status=scheduled&limit=20&since=2025-01-01T00:00:00Z", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "posts" ], "query": [ { "key": "status", "value": "scheduled" }, { "key": "limit", "value": "20" }, { "key": "since", "value": "2025-01-01T00:00:00Z" }, { "key": "until", "value": "" } ] }, "description": "List posts in authenticated key scope with optional `status`, `since`, `until`, and `limit` filters. Response includes scope-wide summary plus per-post media + account states." } }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"caption\": \"Scheduled via Postman\",\n \"media\": {\n \"type\": \"video\",\n \"url\": \"https://media.genviral.com/partner-demo/video.mp4\"\n },\n \"music_url\": \"https://www.tiktok.com/@genviral/video/1234567890\",\n \"accounts\": [\n { \"id\": \"REPLACE_WITH_TIKTOK_ACCOUNT_ID\" }\n ],\n \"tiktok\": {\n \"title\": \"TikTok direct-post title\",\n \"description\": \"Compatibility fallback text for TikTok video title resolution\",\n \"privacy_level\": \"SELF_ONLY\",\n \"video_cover_timestamp_ms\": 1200\n },\n \"scheduled_at\": \"2025-01-31T15:00:00Z\"\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/posts", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "posts" ] }, "description": "Create/schedule a post. Replace account IDs with values from the Accounts request. BYO requests are auto-hosted on Genviral storage, while hosted-only runs validate the provided URLs before scheduling. Include optional `tiktok` (TikTok BYO only) or `pinterest` (Pinterest accounts only) settings, but do not send both in the same request. Partner API rejects unsupported platform-specific objects such as `facebook`, `instagram`, `linkedin`, and `youtube`. `music_url` is TikTok-only; requests that include Instagram or any other non-TikTok targets with music are rejected because Instagram's official publishing API does not support API music/sound selection." } } ] }, { "name": "By ID", "item": [ { "name": "Get", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/posts/{{post_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "posts", "{{post_id}}" ] }, "description": "Fetch the latest status for a specific post. Update the {{post_id}} variable with an ID from the create/list endpoints." } }, { "name": "Update", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"caption\": \"Updated caption from Postman\",\n \"media\": {\n \"type\": \"slideshow\",\n \"urls\": [\n \"https://media.genviral.com/partner-demo/frame-01.jpg\",\n \"https://media.genviral.com/partner-demo/frame-02.jpg\"\n ]\n },\n \"accounts\": [\n { \"id\": \"REPLACE_WITH_PINTEREST_ACCOUNT_ID\" }\n ],\n \"pinterest\": {\n \"title\": \"Updated Pinterest title\",\n \"link\": \"https://www.genviral.io/blog/openclaw-social-posting\",\n \"tags\": [\"open claw\", \"social automation\"]\n },\n \"scheduled_at\": \"2025-02-15T10:00:00Z\",\n \"external_id\": \"partner-run-884\"\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/posts/{{post_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "posts", "{{post_id}}" ] }, "description": "Update a draft/pending/scheduled post. Only include the fields you want to change (caption, media, accounts, scheduled_at, external_id, tiktok, pinterest). Use `null` for `tiktok` or `pinterest` to clear stored settings; these two settings are mutually exclusive based on your targeted accounts. Partner API rejects unsupported platform-specific objects such as `facebook`, `instagram`, `linkedin`, and `youtube`. `music_url` is TikTok-only; requests that include Instagram or any other non-TikTok targets with music are rejected because Instagram's official publishing API does not support API music/sound selection." } } ] }, { "name": "Operations", "item": [ { "name": "Delete (Bulk)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"postIds\": [\"{{post_id}}\", \"post_other_id\"]\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/posts/delete", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "posts", "delete" ] }, "description": "Delete one or many posts (up to 50). Returns deletedIds, blockedStatuses, skipped, and errors for partial successes." } }, { "name": "Retry", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"post_ids\": [\"{{post_id}}\"],\n \"account_ids\": [\"0f4f54d4-8cce-4fb7-8c7b-befbcb8af812\"]\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/posts/retry", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "posts", "retry" ] }, "description": "Retry failed/partial posts (optionally specific account IDs). The response lists retried IDs plus any failures." } } ] } ] }, { "name": "Slideshows", "item": [ { "name": "Copy TikTok", "item": [ { "name": "Preview", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://www.tiktok.com/@creator/photo/7499123456789012345\"\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/copy-tiktok/preview", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "copy-tiktok", "preview" ] }, "description": "Validate TikTok slideshow URL and fetch capped preview metadata + preview_id before import." } }, { "name": "Import", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://www.tiktok.com/@creator/photo/7499123456789012345\",\n \"preview_id\": \"{{preview_id}}\",\n \"pack_id\": \"{{pack_id}}\",\n \"title\": \"Copied Hook Variant\"\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/copy-tiktok/import", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "copy-tiktok", "import" ] }, "description": "Import TikTok slideshow into editable Genviral draft with OCR text mapping and selected pack source." } } ] }, { "name": "Collection", "item": [ { "name": "Generate", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/generate", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "generate" ] }, "description": "Generate a slideshow using AI mode.", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"5 discipline quotes\",\n \"pack_id\": \"11111111-1111-1111-1111-111111111111\",\n \"slide_count\": 5,\n \"slideshow_type\": \"educational\",\n \"aspect_ratio\": \"4:5\",\n \"advanced_settings\": {\n \"font_size\": 44,\n \"text_preset\": \"tiktok\",\n \"text_width\": \"default\"\n }\n}" } } }, { "name": "List", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/slideshows?limit=20&offset=0", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] }, "description": "List slideshows scoped to the authenticated API key." } } ] }, { "name": "By ID", "item": [ { "name": "Get", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/{{slideshow_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "{{slideshow_id}}" ] }, "description": "Fetch one slideshow by ID." } }, { "name": "Update", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/{{slideshow_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "{{slideshow_id}}" ] }, "description": "Update slideshow metadata/settings/slides.", "body": { "mode": "raw", "raw": "{\n \"title\": \"Updated slideshow title\"\n}" } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/{{slideshow_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "{{slideshow_id}}" ] }, "description": "Delete one slideshow by ID." } } ] }, { "name": "Operations", "item": [ { "name": "Render", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/{{slideshow_id}}/render", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "{{slideshow_id}}", "render" ] }, "description": "Render slideshow slides and return updated slideshow state.", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Duplicate", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/{{slideshow_id}}/duplicate", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "{{slideshow_id}}", "duplicate" ] }, "description": "Create a draft copy of an existing slideshow.", "body": { "mode": "raw", "raw": "{}" } } }, { "name": "Regenerate Slide", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/slideshows/{{slideshow_id}}/slides/{{slide_index}}/regenerate", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "slideshows", "{{slideshow_id}}", "slides", "{{slide_index}}", "regenerate" ] }, "description": "Regenerate text for one slide index.", "body": { "mode": "raw", "raw": "{\n \"instruction\": \"Make it punchier\"\n}" } } } ] } ] }, { "name": "Packs", "item": [ { "name": "Collection", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/packs?limit=20&offset=0&include_public=true", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "packs" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" }, { "key": "include_public", "value": "true" } ] }, "description": "List packs in authenticated scope and optional public packs." } }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/packs", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "packs" ] }, "description": "Create a pack in the authenticated key scope.", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Motivation Pack\",\n \"is_public\": false\n}" } } } ] }, { "name": "By ID", "item": [ { "name": "Get", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/packs/{{pack_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "packs", "{{pack_id}}" ] }, "description": "Fetch one pack with image metadata." } }, { "name": "Update", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/packs/{{pack_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "packs", "{{pack_id}}" ] }, "description": "Update pack metadata.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Pack Name\"\n}" } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/packs/{{pack_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "packs", "{{pack_id}}" ] }, "description": "Delete one pack by ID." } } ] }, { "name": "Images", "item": [ { "name": "Add Image URL", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/packs/{{pack_id}}/images", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "packs", "{{pack_id}}", "images" ] }, "description": "Add one image URL reference to a pack. This stores URL metadata only (no file upload/re-host at add time). If you have local file bytes, call /files first and then pass the returned url.", "body": { "mode": "raw", "raw": "{\n \"image_url\": \"https://cdn.example.com/image-1.jpg\",\n \"file_name\": \"image-1.jpg\"\n}" } } }, { "name": "Delete Image", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/packs/{{pack_id}}/images/{{image_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "packs", "{{pack_id}}", "images", "{{image_id}}" ] }, "description": "Delete one image from a pack." } } ] } ] }, { "name": "Templates", "item": [ { "name": "Collection", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/templates?limit=20&offset=0", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "templates" ], "query": [ { "key": "limit", "value": "20" }, { "key": "offset", "value": "0" } ] }, "description": "List partner-visible templates for authenticated scope (private/workspace/public visibility rules)." } }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/templates", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "templates" ] }, "description": "Create a slideshow template.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Hooks Template\",\n \"description\": \"2-slide educational format\",\n \"visibility\": \"private\",\n \"config\": {\n \"version\": 1,\n \"structure\": {\n \"slides\": [\n {\n \"type\": \"pack\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"pinnedImageUrl\": null\n }\n ]\n },\n \"content\": {\n \"mode\": \"manual\",\n \"productId\": null,\n \"language\": \"en\",\n \"slideshowType\": \"educational\"\n },\n \"visuals\": {\n \"packId\": null,\n \"aspectRatio\": \"4:5\",\n \"textSettings\": {\n \"fontSize\": \"default\",\n \"preset\": \"tiktok\",\n \"width\": \"default\"\n }\n }\n }\n}" } } } ] }, { "name": "By ID", "item": [ { "name": "Get", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/templates/{{template_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "templates", "{{template_id}}" ] }, "description": "Fetch one template by ID." } }, { "name": "Update", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/templates/{{template_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "templates", "{{template_id}}" ] }, "description": "Update template metadata/config.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Template Name\"\n}" } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/templates/{{template_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "templates", "{{template_id}}" ] }, "description": "Delete one template by ID." } } ] }, { "name": "Operations", "item": [ { "name": "Create from Slideshow", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/templates/from-slideshow/{{slideshow_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "templates", "from-slideshow", "{{slideshow_id}}" ] }, "description": "Create a template from an existing slideshow.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Converted Winner\",\n \"description\": \"Built from a performing slideshow\",\n \"visibility\": \"workspace\",\n \"preserve_text\": true\n}" } } } ] } ] }, { "name": "Analytics", "item": [ { "name": "Summary", "item": [ { "name": "Get Summary", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/analytics/summary?range=30d&platforms=tiktok,instagram", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "summary" ], "query": [ { "key": "range", "value": "30d" }, { "key": "platforms", "value": "tiktok,instagram" }, { "key": "accounts", "value": "", "disabled": true }, { "key": "start", "value": "", "disabled": true }, { "key": "end", "value": "", "disabled": true } ] }, "description": "Fetch KPI, trend, and content-mix analytics for tracked accounts." } }, { "name": "List Summary Posts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/analytics/summary/posts?range=90d&sortBy=views&sortOrder=desc&limit=25&offset=0", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "summary", "posts" ], "query": [ { "key": "range", "value": "90d" }, { "key": "sortBy", "value": "views" }, { "key": "sortOrder", "value": "desc" }, { "key": "limit", "value": "25" }, { "key": "offset", "value": "0" }, { "key": "platforms", "value": "", "disabled": true }, { "key": "accounts", "value": "", "disabled": true }, { "key": "start", "value": "", "disabled": true }, { "key": "end", "value": "", "disabled": true } ] }, "description": "Fetch paginated post-level analytics rows with sorting and filters. This now returns the canonical backend-enriched summary-post shape directly: `id`/`analyticsId` is the analytics row identifier, `platformPostId` is the platform-native post ID, and `genviralPostId`/`externalId` are backend-owned correlation fields." } } ] }, { "name": "Targets", "item": [ { "name": "List", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/analytics/targets", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "targets" ] }, "description": "List analytics targets scoped to the authenticated API key." } }, { "name": "Create", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"platform\": \"tiktok\",\n \"identifier\": \"@brand\",\n \"alias\": \"Brand HQ\"\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/analytics/targets", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "targets" ] }, "description": "Create (or return existing) analytics target for this scope." } } ] }, { "name": "Target By ID", "item": [ { "name": "Get", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/analytics/targets/{{analytics_target_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "targets", "{{analytics_target_id}}" ] }, "description": "Fetch one analytics target and summary detail." } }, { "name": "Update", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"favorite\": true,\n \"displayName\": \"Brand HQ\"\n}" }, "url": { "raw": "{{base_url}}/api/partner/v1/analytics/targets/{{analytics_target_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "targets", "{{analytics_target_id}}" ] }, "description": "Update analytics target settings (displayName, refreshPolicy, favorite)." } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/analytics/targets/{{analytics_target_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "targets", "{{analytics_target_id}}" ] }, "description": "Delete an analytics target in authenticated scope." } }, { "name": "Refresh", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/analytics/targets/{{analytics_target_id}}/refresh", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "targets", "{{analytics_target_id}}", "refresh" ] }, "description": "Trigger target refresh. Returns refresh metadata and wasFree flag." } } ] }, { "name": "Refreshes", "item": [ { "name": "Get Status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/analytics/refreshes/{{analytics_refresh_id}}", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "refreshes", "{{analytics_refresh_id}}" ] }, "description": "Poll refresh status by refresh ID from target refresh endpoint." } } ] }, { "name": "Workspace Suggestions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/analytics/workspace-suggestions", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "analytics", "workspace-suggestions" ] }, "description": "List suggested workspace/personal scopes with existing tracked analytics accounts." } } ] }, { "name": "Trends", "item": [ { "name": "Get Trend Brief", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{partner_api_token}}" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/partner/v1/trends/brief?platform=tiktok&keyword=morning+routine&limit=10&range=7d", "host": [ "{{base_url}}" ], "path": [ "api", "partner", "v1", "trends", "brief" ], "query": [ { "key": "platform", "value": "tiktok" }, { "key": "keyword", "value": "morning routine" }, { "key": "limit", "value": "10" }, { "key": "range", "value": "7d" } ] }, "description": "Generate an AI-agent ready TikTok trend brief with top hashtags, sounds, creators, posting windows, hook angles, and sample videos. Supported query params: platform=tiktok, keyword (required), limit (1..30), range (24h|7d|30d)." } } ] } ] }