{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.viewsmax.com" } ], "info": { "name": "ViewsMax API Documentation", "_postman_id": "eca935b7-10e9-4c71-84f9-3fa05fabf8bf", "description": "ViewsMax REST API: multi-platform posts, offers, tracking links, analytics, media, and connections. AI agents can also use the MCP server at \/api\/mcp \u2014 see https:\/\/viewsmax.com\/ai.md and \/api\/ai for discovery.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Discovery", "description": "", "item": [ { "name": "AI capability discovery", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/ai", "query": [], "raw": "{{baseUrl}}\/api\/ai" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "max-age=3600, public" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "30" }, { "key": "x-ratelimit-remaining", "value": "29" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"name\":\"ViewsMax\",\"summary\":\"Social posting + link tracking\\\/analytics SaaS. AI agents act on a user's behalf: compose and schedule posts to YouTube, TikTok, X, LinkedIn, Threads, Instagram, and Bluesky; create offers and tracked links; read click, conversion, and revenue stats; research outlier videos (content that massively over-performed its channel) and get AI breakdowns of why they worked. User data is private \\u2014 all access is authenticated.\",\"site\":\"https:\\\/\\\/viewsmax.com\",\"docs\":{\"agents\":\"https:\\\/\\\/viewsmax.com\\\/ai.md\",\"llms_txt\":\"https:\\\/\\\/viewsmax.com\\\/llms.txt\",\"api_reference\":\"https:\\\/\\\/api.viewsmax.com\\\/docs\",\"openapi\":\"https:\\\/\\\/api.viewsmax.com\\\/docs.openapi\"},\"mcp\":{\"endpoint\":\"https:\\\/\\\/api.viewsmax.com\\\/api\\\/mcp\",\"transport\":\"streamable-http\",\"auth\":[{\"type\":\"oauth2\",\"grant\":\"authorization_code\",\"pkce\":true,\"scopes\":[\"mcp\",\"mcp:read\",\"mcp:write\"],\"authorization_server_metadata\":\"https:\\\/\\\/api.viewsmax.com\\\/.well-known\\\/oauth-authorization-server\",\"protected_resource_metadata\":\"https:\\\/\\\/api.viewsmax.com\\\/.well-known\\\/oauth-protected-resource\\\/api\\\/mcp\",\"dynamic_client_registration\":true},{\"type\":\"api_key\",\"header\":\"Authorization: Bearer \",\"key_prefix\":\"vmx_\",\"access_levels\":[\"read\",\"full\"],\"obtain_at\":\"https:\\\/\\\/viewsmax.com\\\/dashboard\\\/settings\"}],\"tools\":[{\"name\":\"list_connected_accounts\",\"description\":\"List every social account the user has connected, plus a Beehiiv newsletter connection if there is one \\u2014 a platform can appear more than once when several accounts are connected on it. Each entry carries social_account_id or connection_id (matching list_brands) plus its store. Posts can only publish to connected platforms; use get_connect_url for anything missing. Beehiiv is connected via an API key on the Connections page, not get_connect_url, and is used for newsletter reach, not posting.\",\"access\":\"read\"},{\"name\":\"list_brands\",\"description\":\"List the user's brands \\u2014 named groups of connected accounts (e.g. a brand holding a TikTok, an X and a YouTube account). Pass a brand id to create_post as brand_id to post to every connected account in the brand at once. Accounts with a status other than \\\"connected\\\" are skipped when posting.\",\"access\":\"read\"},{\"name\":\"upload_media\",\"description\":\"Download a file from a URL and host it on ViewsMax storage for use in posts. Returns a media entry ({type, url, path}) to pass to create_post. Supports jpeg\\\/png\\\/webp\\\/gif images and mp4\\\/mov video. Each call stores a new copy of the file, so don't repeat a call that already succeeded.\",\"access\":\"write\"},{\"name\":\"create_post\",\"description\":\"Compose a social post for one or more platforms (tiktok, youtube, x, linkedin, threads, instagram, bluesky). Target either platforms[] or brand_id (from list_brands, posts to every connected account in the brand) \\u2014 not both. status \\\"draft\\\" (default) saves without publishing, \\\"posted\\\" publishes immediately, \\\"scheduled\\\" publishes at scheduled_at. TikTok takes a video (with a url) or a photo slideshow (one or more image urls); YouTube requires a video with a path \\u2014 both come from upload_media. Instagram needs an image or video url. TikTok photo slideshows accept options.tiktok.auto_add_music (boolean, default false) to let TikTok auto-add its recommended background music; there is no music option for video posts or for Instagram. Publishing\\\/scheduling to TikTok requires options.tiktok.privacy_level (one of PUBLIC_TO_EVERYONE, MUTUAL_FOLLOW_FRIENDS, FOLLOWER_OF_CREATOR, SELF_ONLY) \\u2014 there is no default; branded_content cannot be SELF_ONLY. Ask the user which TikTok privacy_level to use and wait for their answer; never choose it for them. Ask the user which YouTube privacy_status to use (public, unlisted, or private) and wait for their answer; without it the video is public. Caption character limits: tiktok: 2200, youtube: 5000, x: 280, linkedin: 3000, threads: 500, instagram: 2200, bluesky: 300. Publishing is asynchronous: check per-platform results with get_post. Each call creates a new post, so don't repeat a call that already succeeded.\",\"access\":\"write\"},{\"name\":\"list_posts\",\"description\":\"List the user's posts, newest first, with per-platform publish status. Filter by status (draft, scheduled, posted) and\\\/or a scheduled_at date window (from\\\/to, ISO-8601). Returns one page at a time (25 by default); when has_more is true, ask for the next page.\",\"access\":\"read\"},{\"name\":\"get_post\",\"description\":\"Fetch one post by id, including each platform target's publish status (pending, publishing, published, failed) and error message.\",\"access\":\"read\"},{\"name\":\"update_post\",\"description\":\"Edit a draft or scheduled post: caption, media, platforms, schedule, or status. Setting status to \\\"posted\\\" publishes immediately. Posts that have already been published cannot be edited. Ask the user which TikTok privacy_level to use and wait for their answer; never choose it for them. Ask the user which YouTube privacy_status to use (public, unlisted, or private) and wait for their answer; without it the video is public. Caption character limits: tiktok: 2200, youtube: 5000, x: 280, linkedin: 3000, threads: 500, instagram: 2200, bluesky: 300.\",\"access\":\"write\"},{\"name\":\"delete_post\",\"description\":\"Delete a post and its platform targets. Does not remove content already published to the platforms.\",\"access\":\"write\"},{\"name\":\"list_offers\",\"description\":\"List the user's offers (tracked promotions) with their tracking links, goals, and per-offer click\\\/conversion stats. Optional from\\\/to date filter. Returns one page at a time (25 by default); when has_more is true, ask for the next page.\",\"access\":\"read\"},{\"name\":\"create_offer\",\"description\":\"Create an offer (a promotion to track). Requires offer_url; optional name and goals (conversion events with a conversion_url and value). Subject to the user's plan offer limit. Each call creates a new offer, so don't repeat a call that already succeeded.\",\"access\":\"write\"},{\"name\":\"get_offer\",\"description\":\"Fetch one offer by id, with its tracking links and goals.\",\"access\":\"read\"},{\"name\":\"update_offer\",\"description\":\"Update an offer's name, offer_url, goals, or links.\",\"access\":\"write\"},{\"name\":\"delete_offer\",\"description\":\"Delete an offer and stop tracking it.\",\"access\":\"write\"},{\"name\":\"create_tracking_link\",\"description\":\"Create a tracking link for an offer, to place in a video description, email, social bio, etc. Placement is one of: video, email, x, linkedin, podcast, blog, website, tiktok, ad, instagram, beehiiv, other \\u2014 attaching a youtube_video_id or beehiiv_post_id auto-sets the matching placement. Each call creates a new tracking link, so don't repeat a call that already succeeded.\",\"access\":\"write\"},{\"name\":\"get_offer_stats\",\"description\":\"Aggregated analytics across the user's offers: video views, clicks, calls booked, email signups, and sales revenue. Optional from\\\/to window.\",\"access\":\"read\"},{\"name\":\"get_stats_timeseries\",\"description\":\"Daily time-series of clicks and attributed revenue (one bucket per day, gaps zero-filled). Defaults to the last 28 days; filter with from\\\/to and optionally a single offer via event_id.\",\"access\":\"read\"},{\"name\":\"disconnect_account\",\"description\":\"Disconnect a social account by platform (e.g. x, youtube, tiktok). Fully disconnects it \\u2014 nothing is left half-connected \\u2014 and any pending posts targeting that platform will fail to publish.\",\"access\":\"write\"},{\"name\":\"get_connect_url\",\"description\":\"Get the URL of the ViewsMax Connections page where the user can connect a social platform. The user must open the page in a browser and click Connect there \\u2014 the OAuth approval happens on that page and cannot be completed inside this conversation.\",\"access\":\"write\"},{\"name\":\"create_feature_request\",\"description\":\"Submit a feature request to the ViewsMax team on the user's behalf. Don't use this for plan, billing, or purchase requests; tell the user to manage their plan in the ViewsMax app instead. Each call submits a new request, so don't repeat a call that already succeeded.\",\"access\":\"write\"},{\"name\":\"list_outliers\",\"description\":\"Browse outlier videos \\u2014 content that massively over-performed its channel's average (outlier_score = views \\u00f7 channel average views) across YouTube, TikTok and Instagram. Without `query` this is the curated\\\/featured feed; with `query` it returns title matches already in the database. If the response `status` is \\\"queued\\\" or \\\"in_progress\\\" no scrape has finished for that query yet \\u2014 call search_outliers to start one, then re-run this tool. Filter by platform, score, views, subscribers, publish date, duration (long\\\/shorts), channel ids or ISO country codes. Paginated (per_page \\u2264 50).\",\"access\":\"read\"},{\"name\":\"search_outliers\",\"description\":\"Start a background YouTube search (YouTube Data API) for outlier videos matching a keyword\\\/topic. Returns immediately with status \\\"queued\\\"; results land in the shared outlier database over the next minute or two \\u2014 poll list_outliers with the same `query` until its status is \\\"done\\\". Use exact_match to require the whole phrase. This search covers YouTube only: for TikTok and Instagram, add a single video by its link with fetch_outlier, or add a creator's channel with add_outlier_channel to pull in their recent videos.\",\"access\":\"write\"},{\"name\":\"get_outlier\",\"description\":\"Fetch one outlier video by platform + video id (as returned by list_outliers or fetch_outlier), including its channel, views, outlier score and engagement.\",\"access\":\"read\"},{\"name\":\"fetch_outlier\",\"description\":\"Pull a specific video into the outlier database from its URL so it can be analysed (get_outlier, generate_outlier_breakdown, save_outlier). If the video is already known it is returned immediately; otherwise ingestion is queued (`queued: true`) \\u2014 poll get_outlier with the returned platform + video_id.\",\"access\":\"write\"},{\"name\":\"get_outlier_breakdown\",\"description\":\"Read the AI breakdown of an outlier video (hook, structure, why it worked, how to replicate it). `status` is none (never generated \\u2014 call generate_outlier_breakdown), pending\\\/processing (poll again), completed (`payload` holds the analysis) or failed (`error`).\",\"access\":\"read\"},{\"name\":\"generate_outlier_breakdown\",\"description\":\"Queue an AI breakdown of an outlier video (transcript + analysis of the hook, structure and why it over-performed). Generation runs in the background and takes up to a couple of minutes \\u2014 poll get_outlier_breakdown until status is completed. Re-running for a video that already has a breakdown returns the existing one instead of regenerating.\",\"access\":\"write\"},{\"name\":\"list_saved_outliers\",\"description\":\"The user's saved-outliers library (videos they bookmarked with save_outlier), newest first, with tags and the video snapshot taken when saved. Filter by a title\\\/channel query, tag names, platforms, or creator name. Returns one page at a time (25 by default); when has_more is true, ask for the next page.\",\"access\":\"read\"},{\"name\":\"save_outlier\",\"description\":\"Bookmark an outlier video into the user's library, optionally with tags (created on demand). Saving the same video again replaces its tags. The video must already be in the outlier database (list_outliers \\\/ fetch_outlier).\",\"access\":\"write\"},{\"name\":\"remove_saved_outlier\",\"description\":\"Remove a saved video from the user's outlier library by its saved id (from list_saved_outliers \\\/ save_outlier). The video itself stays in the outlier database.\",\"access\":\"write\"},{\"name\":\"add_outlier_channel\",\"description\":\"Add a creator's channel to the outlier database from a profile URL or @handle (YouTube, TikTok, Instagram) and pull in their 10 most recent videos, scored against that channel's own median. Also adds the channel to the user's competitor list. Not for video links \\u2014 use fetch_outlier for those. Returns `status: done` with the channel when it was pulled in the last 24 hours; otherwise `queued: true` with an ingest_id \\u2014 poll get_outlier_channel_ingest until `done`, then list_outliers with `channels: [channel.id]` (and `duration_type: shorts` for TikTok\\\/Instagram) to see the videos. No AI breakdowns are generated.\",\"access\":\"write\"},{\"name\":\"get_outlier_channel_ingest\",\"description\":\"Poll a channel add started by add_outlier_channel. `status` is queued, processing, done (then `channel` is set and `videos_added` says how many videos landed \\u2014 use channel.id in list_outliers `channels`), or failed (then `error` explains why). Pulls take ~10-60 seconds; poll every 5-10 seconds.\",\"access\":\"read\"}]},\"rest\":{\"base_url\":\"https:\\\/\\\/api.viewsmax.com\\\/api\",\"auth\":\"Same vmx_ API key as a Bearer token (posts, offers, tracking, stats, and outliers endpoints only; read-only keys are limited to GET).\",\"openapi\":\"https:\\\/\\\/api.viewsmax.com\\\/docs.openapi\"},\"rate_limits\":{\"mcp_requests_per_minute\":120,\"create_post_per_hour\":180,\"upload_media_per_hour\":40,\"search_outliers_per_hour\":30,\"fetch_outlier_per_hour\":60,\"generate_outlier_breakdown_per_hour\":30,\"add_outlier_channel_per_hour\":10}}", "name": "" } ] } ] }, { "name": "Posts", "description": "\nCompose multi-platform posts (YouTube, TikTok, X, LinkedIn, Threads,\nInstagram, Bluesky) as drafts, publish immediately, or schedule. One post\nfans out to per-platform targets that each report their own publish\nstatus \u2014 publishing is asynchronous, so poll GET \/api\/posts\/{id}.", "item": [ { "name": "Re-queue publishing for a single failed platform target. Only a FAILED\ntarget can be retried, and only that target is touched \u2014 its siblings\n(which may already be published) are left alone, so a retry can never\ndouble-post to a platform that already succeeded.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:post\/targets\/:target\/retry", "query": [], "raw": "{{baseUrl}}\/api\/posts\/:post\/targets\/:target\/retry", "variable": [ { "id": "post", "key": "post", "value": "architecto", "description": "The post." }, { "id": "target", "key": "target", "value": "architecto", "description": "The target." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List the user's posts (with targets). Optional filters: status, and a\nscheduled_at date window (from\/to) used by the calendar view.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts", "query": [], "raw": "{{baseUrl}}\/api\/posts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Create a post.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts", "query": [], "raw": "{{baseUrl}}\/api\/posts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"caption\":\"Big news today!\",\"platforms\":[\"tiktok\",\"instagram\"],\"media\":[{\"type\":\"image\",\"url\":\"https:\\\/\\\/cdn.example\\\/1.jpg\",\"path\":\"posts\\\/1\\\/clip.mp4\"}],\"status\":\"draft\",\"scheduled_at\":\"2026-07-20T18:30:00Z\",\"brand_id\":1,\"overrides\":[],\"options\":[]}" }, "description": "Composes a post and fans it out to the given platforms. Save as a draft,\npublish immediately (status=posted), or schedule (status=scheduled with\nscheduled_at). Publishing is asynchronous \u2014 poll GET \/api\/posts\/{id} for\nper-platform results." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "GET api\/posts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/posts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the post." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "PUT api\/posts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/posts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the post." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "DELETE api\/posts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/posts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the post." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Post Media", "description": "\nUpload media (images \/ video) used by composed posts. Files are stored on the\nconfigured default disk (S3 in production) and returned as a public URL that\nthe platform publishing APIs (e.g. TikTok PULL_FROM_URL) can fetch.", "item": [ { "name": "Upload a single post media file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/media", "query": [], "raw": "{{baseUrl}}\/api\/posts\/media" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Create a direct-upload session.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/media\/direct", "query": [], "raw": "{{baseUrl}}\/api\/posts\/media\/direct" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"architecto\",\"filename\":\"architecto\",\"mime\":\"architecto\",\"size\":16}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Complete a direct upload.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/media\/direct\/complete", "query": [], "raw": "{{baseUrl}}\/api\/posts\/media\/direct\/complete" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"architecto\",\"path\":\"architecto\",\"parts\":[{\"part_number\":22,\"etag\":\"architecto\"}]}" }, "description": "Finalizes the multipart upload (when upload_id is present), verifies the\nstored object against the declared type's size\/mime limits (a presigned\nPUT cannot enforce size), and returns the media entry for the composer." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Abort a multipart direct upload.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/posts\/media\/direct\/abort", "query": [], "raw": "{{baseUrl}}\/api\/posts\/media\/direct\/abort" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"path\":\"architecto\",\"upload_id\":\"architecto\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Offers", "description": "\nOffers are products\/campaigns being promoted (stored as tracking events).\nEach offer has an offer URL and conversion value, owns tracking links, and\naccumulates clicks and conversions. The stats and timeseries endpoints\npower the analytics dashboards.", "item": [ { "name": "Get a list of distinct offer URLs used by the authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events\/offers", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events\/offers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Get aggregated stats for tracking events with date filtering and deduplication.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events\/stats", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events\/stats" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Daily time-series of clicks and attributed revenue for the authenticated\nuser, used by the Analytics overview area charts. Returns one bucket per\nday across the requested window (gaps filled with zeros).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events\/timeseries", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events\/timeseries" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "GA-style acquisition tables: where visitors actually came from.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events\/sources", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events\/sources" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "GET \/api\/tracking-events\/sources?from&to&event_id\n\nReturns `sources` (grouped by classified platform \u2014 google, x, direct\u2026)\nand `referrers` (grouped by the FULL referrer URL), each with distinct\nvisitors + view counts. Pageview-based; falls back to link-click data\n(basis: \"clicks\") until the site has pageview beacons." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List the predefined conversion goal\/event types (seeded reference list).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/goal-types", "query": [], "raw": "{{baseUrl}}\/api\/goal-types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "GET api\/tracking-events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Store a newly created resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"offer_url\":\"http:\\\/\\\/bailey.com\\\/\",\"conversion_value\":4326.41688,\"goals\":[{\"event_type\":\"m\",\"conversion_url\":\"http:\\\/\\\/www.bailey.biz\\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\",\"conversion_value\":8}],\"links\":[{\"youtube_video_id\":\"architecto\",\"placement\":\"architecto\",\"name\":\"architecto\",\"description\":\"Et animi quos velit et fugiat.\"}]}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Display the specified resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tracking event." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Update the specified resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tracking event." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"offer_url\":\"http:\\\/\\\/bailey.com\\\/\",\"conversion_value\":4326.41688,\"goals\":[{\"event_type\":\"m\",\"conversion_url\":\"http:\\\/\\\/www.bailey.biz\\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\",\"conversion_value\":8}],\"links\":[{\"id\":16,\"youtube_video_id\":\"architecto\",\"placement\":\"architecto\",\"name\":\"architecto\",\"description\":\"Et animi quos velit et fugiat.\"}]}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Remove the specified resource from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tracking event." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Tracking Links", "description": "\nTracked links tied to an offer. Place them in videos, posts, emails, or\nbios; ViewsMax records clicks and attributes conversions back to the link\n(and the post\/platform) that drove them.", "item": [ { "name": "Create a new link.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-links", "query": [], "raw": "{{baseUrl}}\/api\/tracking-links" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tracking_event_id\":16,\"youtube_video_id\":\"architecto\",\"placement\":\"architecto\",\"placements\":[\"architecto\"],\"beehiiv_post_id\":\"n\",\"x_post_id\":\"g\",\"instagram_media_id\":\"z\",\"name\":\"architecto\",\"description\":\"Et animi quos velit et fugiat.\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Update the specified resource in storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-links\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tracking-links\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tracking link." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"architecto\",\"placement\":\"architecto\",\"placements\":[\"architecto\"],\"youtube_video_id\":\"architecto\",\"beehiiv_post_id\":\"n\",\"x_post_id\":\"g\",\"instagram_media_id\":\"z\",\"description\":\"Eius et animi quos velit et.\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Remove the specified resource from storage.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-links\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tracking-links\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the tracking link." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List links for a specific event.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tracking-events\/:event\/links", "query": [], "raw": "{{baseUrl}}\/api\/tracking-events\/:event\/links", "variable": [ { "id": "event", "key": "event", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Content", "description": "\nPost and manage content (long-form body text + optional media file) that can be\nattached to an Offer. Media is stored privately and streamed back via the media\nendpoint. All endpoints are scoped to the authenticated user.", "item": [ { "name": "Download content media", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contents\/:id\/media", "query": [], "raw": "{{baseUrl}}\/api\/contents\/:id\/media", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The content id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Streams the stored media file for the content. Useful for large files." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"This content has no media file.\"}", "name": "No media" } ] }, { "name": "List content", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contents", "query": [ { "key": "offer_id", "value": "12", "description": "Filter to content attached to this offer.", "disabled": false }, { "key": "status", "value": "published", "description": "Filter by status (draft|published).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/contents?offer_id=12&status=published" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the authenticated user's content, newest first. Optionally filter by offer or status." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"user_id\":1,\"offer_id\":12,\"title\":\"Launch post\",\"body\":\"...\",\"media_filename\":\"promo.mp4\",\"media_mime\":\"video\/mp4\",\"media_size\":8388608,\"status\":\"published\",\"created_at\":\"2026-06-16T12:00:00.000000Z\",\"updated_at\":\"2026-06-16T12:00:00.000000Z\"}]}", "name": "Success" } ] }, { "name": "Create content", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contents", "query": [], "raw": "{{baseUrl}}\/api\/contents" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "5 ways to grow your channel", "type": "text", "description": "The content title." }, { "key": "body", "value": "Once upon a time...", "type": "text", "description": "The long-form body text (no length limit)." }, { "key": "offer_id", "value": "12", "type": "text", "description": "The id of an offer (owned by you) to attach this content to." }, { "key": "status", "value": "published", "type": "text", "description": "The status: draft or published. Defaults to draft." }, { "key": "media", "src": [], "type": "file" } ] }, "description": "Create a content post. Send as `multipart\/form-data` when including a media file.\nThe `body` accepts long-form text. `media` accepts a single file up to 50 MB." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":1,\"user_id\":1,\"offer_id\":12,\"title\":\"Launch post\",\"body\":\"...\",\"media_filename\":\"promo.mp4\",\"media_mime\":\"video\/mp4\",\"media_size\":8388608,\"status\":\"published\"}}", "name": "Created" }, { "header": [], "code": 422, "body": "{\"message\":\"The title field is required.\",\"errors\":{\"title\":[\"The title field is required.\"]}}", "name": "Validation error" } ] }, { "name": "Show content", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/contents\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The content id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"title\":\"Launch post\",\"body\":\"...\",\"status\":\"published\"}}", "name": "Success" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [App\\\\Models\\\\Content] 1\"}", "name": "Not found" } ] }, { "name": "Update content", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/contents\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The content id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "title", "value": "Updated title", "type": "text", "description": "The content title." }, { "key": "body", "value": "New body text...", "type": "text", "description": "The long-form body text." }, { "key": "offer_id", "value": "12", "type": "text", "description": "The id of an offer (owned by you) to attach." }, { "key": "status", "value": "published", "type": "text", "description": "draft or published." }, { "key": "media", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Update fields and\/or replace the media file. Send `multipart\/form-data` to replace media." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"title\":\"Updated title\",\"status\":\"published\"}}", "name": "Updated" } ] }, { "name": "Delete content", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/contents\/:id", "query": [], "raw": "{{baseUrl}}\/api\/contents\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The content id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the content and any stored media file." }, "response": [ { "header": [], "code": 204, "body": "", "name": "Deleted" } ] } ] }, { "name": "Connections", "description": "\nLegacy connection management (YouTube\/TikTok\/Instagram OAuth token\nexchange). Prefer the \/api\/social endpoints for new integrations.", "item": [ { "name": "List the authenticated user's connections.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/connections", "query": [], "raw": "{{baseUrl}}\/api\/connections" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Delete a connection belonging to the caller.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/connections\/:id", "query": [], "raw": "{{baseUrl}}\/api\/connections\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the connection." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Return the TikTok creator's allowed posting options (privacy levels,\ncomment\/duet\/stitch availability, max duration). The composer must render\nthe privacy\/interaction UI from this before a post can be published.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/connections\/tiktok\/creator-info", "query": [], "raw": "{{baseUrl}}\/api\/connections\/tiktok\/creator-info" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List every platform the app supports plus whether it is configured.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/platforms", "query": [], "raw": "{{baseUrl}}\/api\/social\/platforms" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List the authenticated user's connected accounts (optionally by platform).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/accounts", "query": [], "raw": "{{baseUrl}}\/api\/social\/accounts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Disconnect (delete) a connected account.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/accounts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/social\/accounts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the account." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Build the OAuth authorization URL for a platform. The frontend opens this,\nthe user grants access, and the provider redirects back to redirect_uri\nwith a `code` to be sent to exchange().", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/:platform\/auth-url", "query": [], "raw": "{{baseUrl}}\/api\/social\/:platform\/auth-url", "variable": [ { "id": "platform", "key": "platform", "value": "architecto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Exchange an authorization code (returned to the frontend callback) for\ntokens and persist the connected account(s).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/:platform\/exchange", "query": [], "raw": "{{baseUrl}}\/api\/social\/:platform\/exchange", "variable": [ { "id": "platform", "key": "platform", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"architecto\",\"state\":\"architecto\",\"redirect_uri\":\"http:\\\/\\\/bailey.com\\\/\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Connect a non-OAuth platform (e.g. Bluesky) with direct credentials.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/:platform\/connect", "query": [], "raw": "{{baseUrl}}\/api\/social\/:platform\/connect", "variable": [ { "id": "platform", "key": "platform", "value": "architecto", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Search X users by handle prefix.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/x\/users\/search", "query": [ { "key": "q", "value": "jane", "description": "The typed handle fragment, with or without a leading @.", "disabled": false }, { "key": "social_account_id", "value": "1", "description": "Search as a specific connected X account.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/social\/x\/users\/search?q=jane&social_account_id=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"b\",\"social_account_id\":16}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "30" }, { "key": "x-ratelimit-remaining", "value": "29" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Social Posts", "description": "\nEarlier posting surface (predates \/api\/posts). Prefer the Posts endpoints\nfor new integrations; these remain for existing clients.", "item": [ { "name": "The user's X posts published through the app (both posting stores),\nnewest first \u2014 used to pin a tracking link to a live tweet. Pure DB\nread; the X API plan doesn't allow timeline reads.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/x\/posts", "query": [], "raw": "{{baseUrl}}\/api\/social\/x\/posts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List the user's posts (most recent first).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/posts", "query": [], "raw": "{{baseUrl}}\/api\/social\/posts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Create a post and publish (or schedule) it to the chosen accounts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/posts", "query": [], "raw": "{{baseUrl}}\/api\/social\/posts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"content\":\"b\",\"link\":\"n\",\"account_ids\":[16],\"scheduled_at\":\"2052-10-25\",\"media\":[{\"url\":\"http:\\\/\\\/bailey.com\\\/\",\"type\":\"video\",\"mime\":\"architecto\",\"alt\":\"architecto\"}]}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "GET api\/social\/posts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/posts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/social\/posts\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the post." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Retry the failed targets of a post.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/social\/posts\/:id\/retry", "query": [], "raw": "{{baseUrl}}\/api\/social\/posts\/:id\/retry", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the post." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "API Keys", "description": "\nMCP API key management: one non-expiring key per user,\nrotate-to-invalidate. The key is a Sanctum personal access token scoped to\nthe `mcp` ability, stored hashed; only a display hint is recoverable, so the\nplaintext is returned exactly once from rotate(). The key authenticates the\nMCP server (\/api\/mcp) and the posts\/offers\/tracking REST surface; these\nmanagement endpoints themselves require a login session, not a key.", "item": [ { "name": "GET api\/user\/api-key", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/api-key", "query": [], "raw": "{{baseUrl}}\/api\/user\/api-key" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "POST api\/user\/api-key\/rotate", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/api-key\/rotate", "query": [], "raw": "{{baseUrl}}\/api\/user\/api-key\/rotate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"access\":\"read\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "12" }, { "key": "x-ratelimit-remaining", "value": "10" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Plans", "description": "", "item": [ { "name": "Display a listing of plans.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/plans", "query": [], "raw": "{{baseUrl}}\/api\/plans" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Display the specified plan.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/plans\/:id", "query": [], "raw": "{{baseUrl}}\/api\/plans\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the plan." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Feature Requests", "description": "", "item": [ { "name": "List feature requests, sorted by top votes (default) or newest.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/feature-requests", "query": [], "raw": "{{baseUrl}}\/api\/feature-requests" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Create a feature request and auto-upvote it for the creator.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/feature-requests", "query": [], "raw": "{{baseUrl}}\/api\/feature-requests" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"b\",\"description\":\"Eius et animi quos velit et.\",\"category\":\"v\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Toggle the caller's vote on a feature request.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/feature-requests\/:id\/upvote", "query": [], "raw": "{{baseUrl}}\/api\/feature-requests\/:id\/upvote", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the feature request." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Auth", "description": "\nSession authentication. POST \/api\/login returns a bearer token with full\naccount access. AI agents should prefer a vmx_ API key (Settings \u2192 AI\nAssistant Access) or the MCP OAuth flow instead of storing passwords.", "item": [ { "name": "Register a new user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/register", "query": [], "raw": "{{baseUrl}}\/api\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"password\":\"-0pBNvYgxw\",\"marketing_consent\":false}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 422, "body": "{\"success\":false,\"message\":\"Validation failed\",\"errors\":{\"password\":[\"The password field confirmation does not match.\"]}}", "name": "" } ] }, { "name": "Login user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/login", "query": [], "raw": "{{baseUrl}}\/api\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"password\":\"|]|{+-\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid credentials\"}", "name": "" } ] }, { "name": "Send password reset email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"success\":true,\"message\":\"If an account with that email exists, we have sent a password reset link.\"}", "name": "" } ] }, { "name": "Reset password using token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"token\":\"architecto\",\"password\":\"]|{+-0pBNvYg\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 422, "body": "{\"success\":false,\"message\":\"Validation failed\",\"errors\":{\"password\":[\"The password field confirmation does not match.\"]}}", "name": "" } ] }, { "name": "Verify a user's email via the magic-link token. Logs the user in on success.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/verify-email", "query": [], "raw": "{{baseUrl}}\/api\/auth\/verify-email" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"architecto\"}" }, "description": "Idempotent under React StrictMode double-calls." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 422, "body": "{\"message\":\"This verification link is invalid or has expired.\"}", "name": "" } ] }, { "name": "Resend a verification magic link. Always returns 200 (no account enumeration).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/auth\/resend-verification", "query": [], "raw": "{{baseUrl}}\/api\/auth\/resend-verification" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"success\":true}", "name": "" } ] }, { "name": "Logout user (revoke token)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/logout", "query": [], "raw": "{{baseUrl}}\/api\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Get authenticated user profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/profile", "query": [], "raw": "{{baseUrl}}\/api\/profile" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Refresh token (create new token and revoke old one)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/refresh", "query": [], "raw": "{{baseUrl}}\/api\/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Audience Growth", "description": "\nRead-only analytics over the daily snapshot tables (audience_snapshots,\npost_metric_snapshots) populated by audience:refresh \/ posts:refresh-metrics.\nRevenue Growth reuses TrackingEventController@getTimeseries and isn't here.", "item": [ { "name": "Per-platform follower series over the date range, one entry per connected\naccount: current count, day-over-day delta across the range, and points.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/analytics\/audience", "query": [], "raw": "{{baseUrl}}\/api\/analytics\/audience" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Posts ranked by engagement (total, latest snapshot in range) with a\nday-over-day delta. Optional ?platform= filter.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/analytics\/posts", "query": [], "raw": "{{baseUrl}}\/api\/analytics\/posts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Boosts", "description": "\nPer-account Boost automations (X-only v1): Auto Repost retweets a post once\nit reaches a like threshold; Auto Promo replies to it with a promo comment.\nChecks run 6h apart, up to 3 times per post, and stop on success.", "item": [ { "name": "All of the user's boost settings, keyed for the Boosts page.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/boosts\/settings", "query": [], "raw": "{{baseUrl}}\/api\/boosts\/settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Create or update one feature's setting on one connected account.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/boosts\/settings\/:socialAccountId", "query": [], "raw": "{{baseUrl}}\/api\/boosts\/settings\/:socialAccountId", "variable": [ { "id": "socialAccountId", "key": "socialAccountId", "value": "architecto", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"feature\":\"architecto\",\"enabled\":false,\"likes_threshold\":22,\"promo_text\":\"architecto\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Recent boost activity (triggered\/exhausted\/failed checks), newest first.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/boosts\/activity", "query": [], "raw": "{{baseUrl}}\/api\/boosts\/activity" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Brands", "description": "\nNamed groups of connected accounts. Selecting a brand in the composer\nauto-selects every account in it. Members may come from either account\nstore: social_accounts (X, Instagram, ...) or legacy connections\n(YouTube, TikTok).", "item": [ { "name": "List the authenticated user's brands with their member accounts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brands", "query": [], "raw": "{{baseUrl}}\/api\/brands" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Create a brand.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brands", "query": [], "raw": "{{baseUrl}}\/api\/brands" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Acme\",\"social_account_ids\":[1,2],\"connection_ids\":[3]}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Update a brand. Member lists are replaced only when their key is present,\nso a rename-only payload never wipes membership.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the brand." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Delete a brand. Member accounts are untouched; posts keep existing but\nlose their brand link.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/brands\/:id", "query": [], "raw": "{{baseUrl}}\/api\/brands\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the brand." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "POST api\/free-tools\/transcript", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/free-tools\/transcript", "query": [], "raw": "{{baseUrl}}\/api\/free-tools\/transcript" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"youtube\",\"url\":\"http:\\\/\\\/www.bailey.biz\\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "15" }, { "key": "x-ratelimit-remaining", "value": "14" }, { "key": "vary", "value": "Origin" } ], "code": 422, "body": "{\"success\":false,\"message\":\"That doesn't look like a valid youtube link.\"}", "name": "" } ] }, { "name": "GET api\/health", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/health", "query": [], "raw": "{{baseUrl}}\/api\/health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 200, "body": "{\"status\":\"healthy\",\"timestamp\":\"2026-10-02T07:31:18.968796Z\",\"service\":\"Title Embedding API\",\"version\":\"1.0.0\"}", "name": "" } ] }, { "name": "GET api\/user\/settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/settings", "query": [], "raw": "{{baseUrl}}\/api\/user\/settings" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "PATCH api\/user\/settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/settings", "query": [], "raw": "{{baseUrl}}\/api\/user\/settings" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"notify_post_failures\":true,\"locale\":\"es\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "GET api\/user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user", "query": [], "raw": "{{baseUrl}}\/api\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "GET api\/user\/mcp-activity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/mcp-activity", "query": [], "raw": "{{baseUrl}}\/api\/user\/mcp-activity" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "Image Generation", "description": "\nAPIs for generating AI images using Flux 2", "item": [ { "name": "Get Image Generation Configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/image\/generate\/config", "query": [], "raw": "{{baseUrl}}\/api\/image\/generate\/config" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve configuration options for image generation including available methods, quality presets, defaults, and limits." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Configuration retrieved successfully\",\"data\":{\"enabled\":true,\"methods\":[\"generate\",\"head_swap\"],\"qualities\":[\"fast\",\"normal\",\"high\",\"very_high\"],\"defaults\":{\"quality\":\"fast\",\"steps\":4,\"refine_enabled\":false,\"inpainting_enabled\":true,\"number_of_images\":1},\"limits\":{\"max_prompt_length\":2000,\"max_image_size_bytes\":10485760,\"max_additional_images\":3,\"max_number_of_images\":10}}}", "name": "" } ] }, { "name": "List Generated Images", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/image\/generate", "query": [ { "key": "status", "value": "completed", "description": "Filter by status: `pending`, `processing`, `completed`, `failed`.", "disabled": false }, { "key": "method", "value": "generate", "description": "Filter by method: `generate`, `head_swap`.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/image\/generate?status=completed&method=generate&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get a paginated list of the authenticated user's generated images. Can be filtered by status and method." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Images retrieved successfully\",\"data\":{\"current_page\":1,\"data\":[...],\"per_page\":15,\"total\":100}}", "name": "" } ] }, { "name": "Create Image Generation Request", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/image\/generate", "query": [], "raw": "{{baseUrl}}\/api\/image\/generate" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"method\":\"generate\",\"quality\":\"normal\",\"prompt\":\"A person standing confidently in front of a mountain\",\"base_image_url\":\"https:\\\/\\\/example.com\\\/image.jpg\",\"number_of_images\":2}" }, "description": "Create a new image generation request. Credits will be deducted based on the number of images requested (50 credits per image)." }, "response": [ { "header": [], "code": 202, "body": "{\"success\":true,\"message\":\"Image generation started\",\"data\":{\"id\":123,\"status\":\"pending\",\"method\":\"generate\",\"quality\":\"normal\",\"estimated_time_seconds\":40}}", "name": "" }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"For generate method, please upload a base image, provide an image URL, or set a default reference image at \/user\/default-image.\"}", "name": "" }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Reference image is required for head swap. You can upload a default image at \/user\/default-image.\"}", "name": "" }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"Failed to download or validate base image from URL. Please check the URL and try again.\"}", "name": "" }, { "header": [], "code": 503, "body": "{\"success\":false,\"message\":\"Image generation feature is not enabled\"}", "name": "" } ] }, { "name": "Get Generated Image Details", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/image\/generate\/:id", "query": [], "raw": "{{baseUrl}}\/api\/image\/generate\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the generated image." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve detailed information about a specific generated image." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Generated image retrieved successfully\",\"data\":{\"id\":123,\"method\":\"generate\",\"quality\":\"normal\",\"status\":\"completed\",\"prompt\":\"A person standing confidently\",\"base_image_url\":\"https:\/\/...\",\"reference_image_url\":\"https:\/\/...\",\"result_image_url\":\"https:\/\/...\",\"result_image_urls\":[\"https:\/\/...\",\"https:\/\/...\"],\"result_image_count\":2,\"megapixel\":0.5,\"steps\":4,\"refine_enabled\":false,\"inpainting_enabled\":true,\"number_of_images\":2,\"error_message\":null,\"processing_log\":[...],\"created_at\":\"2024-01-28T10:00:00Z\",\"updated_at\":\"2024-01-28T10:01:00Z\"}}", "name": "" }, { "header": [], "code": 404, "body": "{\"success\":false,\"message\":\"Generated image not found\"}", "name": "" } ] }, { "name": "Get Image Generation Status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/image\/generate\/:id\/status", "query": [], "raw": "{{baseUrl}}\/api\/image\/generate\/:id\/status", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the generated image." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Check the processing status of a generated image. Use this to poll for completion." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Status retrieved successfully\",\"data\":{\"id\":123,\"status\":\"processing\",\"is_complete\":false,\"is_successful\":false}}", "name": "" }, { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Status retrieved successfully\",\"data\":{\"id\":123,\"status\":\"completed\",\"is_complete\":true,\"is_successful\":true,\"result_image_url\":\"https:\/\/...\",\"result_image_urls\":[\"https:\/\/...\"],\"result_image_count\":2}}", "name": "" }, { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Status retrieved successfully\",\"data\":{\"id\":123,\"status\":\"failed\",\"is_complete\":true,\"is_successful\":false,\"error_message\":\"Error details...\"}}", "name": "" }, { "header": [], "code": 404, "body": "{\"success\":false,\"message\":\"Generated image not found\"}", "name": "" } ] }, { "name": "Download Generated Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/image\/generate\/:id\/download", "query": [], "raw": "{{baseUrl}}\/api\/image\/generate\/:id\/download", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the generated image." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Download the generated image file. Returns a binary PNG file." }, "response": [ { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"No result image available for download\"}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"success\":false,\"message\":\"Generated image not found\"}", "name": "" } ] }, { "name": "Delete Generated Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/image\/generate\/:id", "query": [], "raw": "{{baseUrl}}\/api\/image\/generate\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the generated image." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete a generated image and all associated files." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Generated image deleted successfully\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"success\":false,\"message\":\"Generated image not found\"}", "name": "" } ] } ] }, { "name": "Outliers", "description": "\nOutlier videos: content that massively over-performed its channel's average\n(`outlier_score` = views \u00f7 channel average views) across YouTube, TikTok and\nInstagram. Browse the shared database, pull in specific URLs, and get AI\nbreakdowns of why a video worked.", "item": [ { "name": "Browse outliers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers", "query": [], "raw": "{{baseUrl}}\/api\/outliers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"query\":\"architecto\",\"min_score\":39,\"min_views\":84,\"max_views\":12,\"min_subs\":77,\"max_subs\":8,\"published_before\":\"2026-10-02T07:31:19\",\"published_after\":\"2026-10-02T07:31:19\",\"sort_by\":\"recent\",\"keyword_match\":\"architecto\",\"featured\":true,\"platform\":\"tiktok\",\"channels\":[\"architecto\"],\"countries\":[\"ng\"],\"page\":66,\"per_page\":17}" }, "description": "Paginated outlier videos. Without `query` this is the curated feed; with\n`query` it returns title matches already in the database plus a `status`\n(queued \/ in_progress \/ done) for the background scrape of that term \u2014\nstart one with the search endpoint." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List outlier channels", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/channels", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/channels" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"instagram\",\"q\":\"architecto\",\"limit\":22}" }, "description": "Distinct channels in the outlier database (for the `channels` filter of the browse endpoint)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Add a channel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/channels\/add", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/channels\/add" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"tiktok\",\"input\":\"https:\\\/\\\/www.tiktok.com\\\/@khaby.lame\",\"max_videos\":10}" }, "description": "Queue a pull of the creator's most recent videos. Returns HTTP 200 with\n`status: done` when the channel was already pulled in the last 24 hours,\notherwise HTTP 202 with an `ingest_id` to poll." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "10" }, { "key": "x-ratelimit-remaining", "value": "8" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Channel ingest status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/channels\/ingests\/:id", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/channels\/ingests\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "The ingest id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Poll an ingest started by the add endpoint until `status` is `done`\n(then `channel` is set) or `failed` (then `error` explains why)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Start an outlier search", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/search", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/search" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"term\":\"faceless youtube automation\",\"exact_match\":false}" }, "description": "Queue a background scrape for a keyword\/topic. Poll the browse endpoint\nwith the same `query` until its `status` is `done`." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Fetch an outlier by URL", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/fetch", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/fetch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"instagram\",\"url\":\"http:\\\/\\\/www.bailey.biz\\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"}" }, "description": "Ingest a single video by URL so it can be analysed. Known videos return\nimmediately; otherwise ingestion is queued (HTTP 202, `queued: true`) \u2014\npoll the show endpoint with the returned platform + video_id. YouTube goes\nthrough the YouTube API; TikTok\/Instagram go through CaptAPI (no\nchannel-listing endpoint there, so those are pulled one URL at a time)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List library tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/tags", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/tags" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Distinct tag names the user has applied to saved outliers." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "List saved outliers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/library", "query": [ { "key": "q", "value": "hook", "description": "Matches saved title or channel name.", "disabled": false }, { "key": "tags[0]", "value": "architecto", "description": "Only items carrying any of these tag names.", "disabled": false }, { "key": "platforms[0]", "value": "architecto", "description": "youtube, tiktok, instagram.", "disabled": false }, { "key": "creator", "value": "architecto", "description": "Channel\/creator name filter.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/outliers\/library?q=hook&tags[0]=architecto&platforms[0]=architecto&creator=architecto" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "The user's library, newest first." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Save an outlier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/library", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/library" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"platform\":\"tiktok\",\"video_id\":\"architecto\",\"snapshot\":[],\"tags\":[\"b\"]}" }, "description": "Bookmark a video into the library with a snapshot of its stats. Saving the\nsame video again replaces its tags." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Update a saved outlier's tags", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/library\/:id", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/library\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the library." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tags\":[\"b\"]}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Remove a saved outlier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/library\/:id", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/library\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the library." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Get an outlier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/:platform\/:videoId", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/:platform\/:videoId", "variable": [ { "id": "platform", "key": "platform", "value": "youtube", "description": "youtube, tiktok, or instagram." }, { "id": "videoId", "key": "videoId", "value": "dQw4w9WgXcQ", "description": "The platform's video id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "A single outlier video with its channel." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Get an outlier's AI breakdown", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/:platform\/:videoId\/breakdown", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/:platform\/:videoId\/breakdown", "variable": [ { "id": "platform", "key": "platform", "value": "youtube", "description": "youtube, tiktok, or instagram." }, { "id": "videoId", "key": "videoId", "value": "dQw4w9WgXcQ", "description": "The platform's video id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "`status` is none (never generated), pending\/processing (poll again),\ncompleted (`payload` holds the analysis) or failed (`error`)." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] }, { "name": "Generate an outlier's AI breakdown", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/outliers\/:platform\/:videoId\/breakdown", "query": [], "raw": "{{baseUrl}}\/api\/outliers\/:platform\/:videoId\/breakdown", "variable": [ { "id": "platform", "key": "platform", "value": "youtube", "description": "youtube, tiktok, or instagram." }, { "id": "videoId", "key": "videoId", "value": "dQw4w9WgXcQ", "description": "The platform's video id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Queues generation (transcript + LLM analysis); poll the GET endpoint until\n`status` is completed. An existing breakdown is returned, not regenerated." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"success\":false,\"message\":\"Invalid token\"}", "name": "" } ] } ] }, { "name": "User Default Reference Image", "description": "\nAPIs for managing a user's default reference image for image generation", "item": [ { "name": "Get Default Reference Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/default-image", "query": [], "raw": "{{baseUrl}}\/api\/user\/default-image" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieve the authenticated user's current default reference image." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Default reference image retrieved successfully\",\"data\":{\"has_default_image\":true,\"image_url\":\"https:\/\/your-domain.com\/storage\/user-defaults\/1\/image.png\"}}", "name": "" }, { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"No default reference image set\",\"data\":{\"has_default_image\":false,\"image_url\":null}}", "name": "" } ] }, { "name": "Upload Default Reference Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/default-image", "query": [], "raw": "{{baseUrl}}\/api\/user\/default-image" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "Upload a new default reference image for the authenticated user. This image will be used as a fallback when no reference image is provided in generation requests." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Default reference image uploaded successfully\",\"data\":{\"has_default_image\":true,\"image_url\":\"https:\/\/your-domain.com\/storage\/user-defaults\/1\/image.png\"}}", "name": "" } ] }, { "name": "Delete Default Reference Image", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/default-image", "query": [], "raw": "{{baseUrl}}\/api\/user\/default-image" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove the authenticated user's default reference image." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":true,\"message\":\"Default reference image removed successfully\"}", "name": "" }, { "header": [], "code": 400, "body": "{\"success\":false,\"message\":\"No default reference image to remove\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }