{ "openapi": "3.1.0", "info": { "title": "Socialix API", "version": "1", "description": "Make branded posts from links with your templates, check them, fetch the results and run your automations. Every paid plan. Docs: https://socialix.ai/docs" }, "servers": [ { "url": "https://socialix.ai/api" } ], "components": { "schemas": { "AutomationCreate": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name" }, "template_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Id" }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Folder Id" }, "route_overrides": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "$ref": "#/components/schemas/RouteOverrideIn" } ] }, "type": "object" }, { "type": "null" } ], "title": "Route Overrides" }, "run_hour": { "type": "integer", "maximum": 23.0, "minimum": 0.0, "title": "Run Hour" }, "run_minute": { "type": "integer", "maximum": 59.0, "minimum": 0.0, "title": "Run Minute" }, "max_posts_per_day": { "type": "integer", "maximum": 10.0, "minimum": 1.0, "title": "Max Posts Per Day", "default": 10 }, "always_crop": { "type": "boolean", "title": "Always Crop", "default": true }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "workspace_topic_opt_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Workspace Topic Opt In" }, "workspace_topic_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Topic Scope" }, "sources": { "items": { "$ref": "#/components/schemas/SourceIn" }, "type": "array", "maxItems": 10, "minItems": 1, "title": "Sources" } }, "type": "object", "required": [ "name", "run_hour", "run_minute", "sources" ], "title": "AutomationCreate" }, "AutomationLimitsOut": { "properties": { "automations_cap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Automations Cap" }, "automations_used": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Automations Used" }, "posts_per_day_cap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Posts Per Day Cap" } }, "type": "object", "required": [ "automations_cap", "automations_used", "posts_per_day_cap" ], "title": "AutomationLimitsOut" }, "AutomationOut": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "template_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Id" }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Folder Id" }, "folder": { "anyOf": [ { "$ref": "#/components/schemas/FolderRef" }, { "type": "null" } ] }, "route_overrides": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "additionalProperties": true, "type": "object" } ] }, "type": "object" }, { "type": "null" } ], "title": "Route Overrides" }, "route_health": { "anyOf": [ { "$ref": "#/components/schemas/RouteHealth" }, { "type": "null" } ] }, "run_hour": { "type": "integer", "title": "Run Hour" }, "run_minute": { "type": "integer", "title": "Run Minute" }, "schedule_timezone": { "type": "string", "title": "Schedule Timezone", "default": "UTC" }, "max_posts_per_day": { "type": "integer", "title": "Max Posts Per Day" }, "always_crop": { "type": "boolean", "title": "Always Crop" }, "enabled": { "type": "boolean", "title": "Enabled" }, "pause_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pause Reason" }, "next_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Next Run At" }, "initial_run_pending": { "type": "boolean", "title": "Initial Run Pending", "default": false }, "workspace_topic_opt_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Workspace Topic Opt In" }, "workspace_topic_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Topic Scope" }, "destination_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Id" }, "destination": { "anyOf": [ { "$ref": "#/components/schemas/api__routers__automations__schemas__DestinationOut" }, { "type": "null" } ] }, "delivers_to": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryOut" }, { "type": "null" } ] }, "last_run_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Run At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "sources": { "items": { "$ref": "#/components/schemas/SourceOut" }, "type": "array", "title": "Sources", "default": [] }, "latest_run": { "anyOf": [ { "$ref": "#/components/schemas/RunOut" }, { "type": "null" } ] }, "low_fill": { "anyOf": [ { "$ref": "#/components/schemas/LowFillOut" }, { "type": "null" } ] }, "needs_target": { "type": "boolean", "title": "Needs Target", "readOnly": true } }, "type": "object", "required": [ "id", "name", "run_hour", "run_minute", "max_posts_per_day", "always_crop", "enabled", "last_run_at", "created_at", "updated_at", "needs_target" ], "title": "AutomationOut" }, "AutomationOutput": { "properties": { "id": { "type": "integer", "title": "Id" }, "public_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Id" }, "run_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Run Id" }, "status": { "type": "string", "title": "Status" }, "input_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Url" }, "result_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result File Id" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "finished_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Finished At" } }, "type": "object", "required": [ "id", "public_id", "status", "input_url", "result_file_id", "error_code", "error_message", "created_at", "finished_at" ], "title": "AutomationOutput" }, "AutomationUpdate": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "template_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Id" }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Folder Id" }, "route_overrides": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "integer" }, { "$ref": "#/components/schemas/RouteOverrideIn" } ] }, "type": "object" }, { "type": "null" } ], "title": "Route Overrides" }, "run_hour": { "anyOf": [ { "type": "integer", "maximum": 23.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Run Hour" }, "run_minute": { "anyOf": [ { "type": "integer", "maximum": 59.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Run Minute" }, "max_posts_per_day": { "anyOf": [ { "type": "integer", "maximum": 10.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Max Posts Per Day" }, "always_crop": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Always Crop" }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "workspace_topic_opt_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Workspace Topic Opt In" }, "workspace_topic_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Topic Scope" }, "destination_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Id" }, "sources": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SourceIn" }, "type": "array", "maxItems": 10, "minItems": 1 }, { "type": "null" } ], "title": "Sources" } }, "type": "object", "title": "AutomationUpdate" }, "BatchCreate": { "properties": { "template_id": { "type": "integer", "title": "Template Id" }, "items": { "items": { "$ref": "#/components/schemas/BatchItemCreate" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Items" }, "image_source_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Source Mode" } }, "type": "object", "required": [ "template_id", "items" ], "title": "BatchCreate" }, "BatchItemCreate": { "properties": { "source_post_url": { "type": "string", "title": "Source Post Url" } }, "type": "object", "required": [ "source_post_url" ], "title": "BatchItemCreate" }, "BatchJob": { "properties": { "id": { "type": "integer", "title": "Id" }, "public_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Id" }, "source_post_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Post Url" } }, "type": "object", "required": [ "id" ], "title": "BatchJob" }, "BatchResponse": { "properties": { "batch_id": { "type": "string", "title": "Batch Id" }, "template_id": { "type": "integer", "title": "Template Id" }, "template_name": { "type": "string", "title": "Template Name" }, "jobs": { "items": { "$ref": "#/components/schemas/BatchJob" }, "type": "array", "title": "Jobs" } }, "type": "object", "required": [ "batch_id", "template_id", "template_name", "jobs" ], "title": "BatchResponse" }, "BatchStatusResponse": { "properties": { "batch_id": { "type": "string", "title": "Batch Id" }, "total": { "type": "integer", "title": "Total" }, "completed": { "type": "integer", "title": "Completed" }, "failed": { "type": "integer", "title": "Failed" }, "in_progress": { "type": "integer", "title": "In Progress" }, "job_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Type" }, "template_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Name" }, "eta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Eta" } }, "type": "object", "required": [ "batch_id", "total", "completed", "failed", "in_progress" ], "title": "BatchStatusResponse" }, "Body_upload_file_uploads__post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_file_uploads__post" }, "BoostStepOut": { "properties": { "level": { "type": "integer", "title": "Level" }, "price_usd": { "type": "integer", "title": "Price Usd" }, "extra_credits": { "type": "integer", "title": "Extra Credits" }, "monthly_total": { "type": "integer", "title": "Monthly Total" } }, "type": "object", "required": [ "level", "price_usd", "extra_credits", "monthly_total" ], "title": "BoostStepOut" }, "CreditOptionsOut": { "properties": { "boost_steps": { "items": { "$ref": "#/components/schemas/BoostStepOut" }, "type": "array", "title": "Boost Steps" }, "topup_packs": { "items": { "$ref": "#/components/schemas/TopupPackOut" }, "type": "array", "title": "Topup Packs" } }, "type": "object", "required": [ "boost_steps", "topup_packs" ], "title": "CreditOptionsOut" }, "CreditPricesOut": { "properties": { "download": { "type": "integer", "title": "Download" }, "crop": { "type": "integer", "title": "Crop" }, "simple_create": { "type": "integer", "title": "Simple Create" }, "post_rebrand": { "type": "integer", "title": "Post Rebrand" }, "tweet_rebrand": { "type": "integer", "title": "Tweet Rebrand" }, "ai_rebrand": { "type": "integer", "title": "Ai Rebrand" }, "metered": { "type": "boolean", "title": "Metered" }, "monthly_grant": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Monthly Grant" }, "canvas_base": { "type": "integer", "title": "Canvas Base" }, "canvas_extra_source": { "type": "integer", "title": "Canvas Extra Source" } }, "type": "object", "required": [ "download", "crop", "simple_create", "post_rebrand", "tweet_rebrand", "ai_rebrand", "metered", "monthly_grant", "canvas_base", "canvas_extra_source" ], "title": "CreditPricesOut" }, "CreditsOut": { "properties": { "balance": { "type": "integer", "title": "Balance" }, "monthly": { "type": "integer", "title": "Monthly" }, "topup": { "type": "integer", "title": "Topup" }, "pooled": { "type": "boolean", "title": "Pooled" }, "metered": { "type": "boolean", "title": "Metered" } }, "type": "object", "required": [ "balance", "monthly", "topup", "pooled", "metered" ], "title": "CreditsOut" }, "CropJobCreate": { "properties": { "url": { "type": "string", "title": "Url" }, "apply_crop": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply Crop", "default": true } }, "type": "object", "required": [ "url" ], "title": "CropJobCreate" }, "DeliveryOut": { "properties": { "kind": { "type": "string", "enum": [ "chat", "web", "per_template" ], "title": "Kind" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "via": { "anyOf": [ { "type": "string", "enum": [ "automation", "template" ] }, { "type": "null" } ], "title": "Via" }, "destination_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Id" } }, "type": "object", "required": [ "kind" ], "title": "DeliveryOut" }, "DownloadJobCreate": { "properties": { "url": { "type": "string", "title": "Url" } }, "type": "object", "required": [ "url" ], "title": "DownloadJobCreate" }, "FanoutCreate": { "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "default": "" }, "template_ids": { "items": { "type": "integer" }, "type": "array", "maxItems": 20, "minItems": 1, "title": "Template Ids" }, "element_overrides": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Element Overrides" }, "apply_crop": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply Crop" }, "picture_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Picture Urls" }, "video_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Video Urls" }, "manual_tweet_text": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Manual Tweet Text" }, "image_source_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Source Mode" } }, "type": "object", "required": [ "template_ids" ], "title": "FanoutCreate" }, "FanoutJob": { "properties": { "id": { "type": "integer", "title": "Id" }, "public_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Id" }, "template_id": { "type": "integer", "title": "Template Id" }, "template_name": { "type": "string", "title": "Template Name" } }, "type": "object", "required": [ "id", "template_id", "template_name" ], "title": "FanoutJob" }, "FanoutResponse": { "properties": { "batch_id": { "type": "string", "title": "Batch Id" }, "jobs": { "items": { "$ref": "#/components/schemas/FanoutJob" }, "type": "array", "title": "Jobs" } }, "type": "object", "required": [ "batch_id", "jobs" ], "title": "FanoutResponse" }, "FeatureOut": { "properties": { "key": { "type": "string", "title": "Key" }, "label": { "type": "string", "title": "Label" }, "included": { "type": "boolean", "title": "Included" } }, "type": "object", "required": [ "key", "label", "included" ], "title": "FeatureOut" }, "FeedItem": { "properties": { "profile_id": { "type": "integer", "title": "Profile Id" }, "handle": { "type": "string", "title": "Handle" }, "post": { "$ref": "#/components/schemas/api__routers__performance__PostOut" } }, "type": "object", "required": [ "profile_id", "handle", "post" ], "title": "FeedItem" }, "FolderCreate": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "FolderCreate" }, "FolderRef": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "id", "name" ], "title": "FolderRef" }, "FolderResponse": { "properties": { "id": { "type": "integer", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "template_count": { "type": "integer", "title": "Template Count", "default": 0 }, "automation_count": { "type": "integer", "title": "Automation Count", "default": 0 } }, "type": "object", "required": [ "id", "name", "created_at" ], "title": "FolderResponse" }, "FolderUpdate": { "properties": { "name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "FolderUpdate" }, "FollowerHistoryEntry": { "properties": { "taken_at": { "type": "string", "format": "date-time", "title": "Taken At" }, "followers_count": { "type": "integer", "title": "Followers Count" } }, "type": "object", "required": [ "taken_at", "followers_count" ], "title": "FollowerHistoryEntry" }, "FollowerPoint": { "properties": { "taken_at": { "type": "string", "format": "date-time", "title": "Taken At" }, "followers": { "type": "integer", "title": "Followers" } }, "type": "object", "required": [ "taken_at", "followers" ], "title": "FollowerPoint" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HighlightPost": { "properties": { "profile_id": { "type": "integer", "title": "Profile Id" }, "profile_handle": { "type": "string", "title": "Profile Handle" }, "reel_id": { "type": "string", "title": "Reel Id" }, "reel_url": { "type": "string", "title": "Reel Url" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caption" }, "posted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Posted At" }, "post_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Type" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" }, "comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comments" }, "multiple": { "type": "number", "title": "Multiple" } }, "type": "object", "required": [ "profile_id", "profile_handle", "reel_id", "reel_url", "thumbnail_url", "caption", "posted_at", "post_type", "likes", "views", "comments", "multiple" ], "title": "HighlightPost" }, "HighlightProfile": { "properties": { "id": { "type": "integer", "title": "Id" }, "handle": { "type": "string", "title": "Handle" }, "profile_image_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Image Link" }, "followers_count": { "type": "integer", "title": "Followers Count" }, "follower_delta": { "type": "integer", "title": "Follower Delta" }, "follower_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Follower Pct" }, "follower_delta_span_hours": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Follower Delta Span Hours" } }, "type": "object", "required": [ "id", "handle", "profile_image_link", "followers_count", "follower_delta", "follower_delta_span_hours" ], "title": "HighlightProfile" }, "HighlightsResponse": { "properties": { "best_post": { "anyOf": [ { "$ref": "#/components/schemas/HighlightPost" }, { "type": "null" } ] }, "most_improved": { "anyOf": [ { "$ref": "#/components/schemas/HighlightProfile" }, { "type": "null" } ] }, "biggest_decliner": { "anyOf": [ { "$ref": "#/components/schemas/HighlightProfile" }, { "type": "null" } ] } }, "type": "object", "title": "HighlightsResponse" }, "JobCreate": { "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "default": "" }, "template_id": { "type": "integer", "title": "Template Id" }, "element_overrides": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Element Overrides" }, "apply_crop": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply Crop" }, "picture_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Picture Urls" }, "video_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 20 }, { "type": "null" } ], "title": "Video Urls" }, "manual_tweet_text": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Manual Tweet Text" }, "image_source_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Source Mode" }, "lane": { "anyOf": [ { "type": "string", "enum": [ "interactive", "bulk" ] }, { "type": "null" } ], "title": "Lane" } }, "type": "object", "required": [ "template_id" ], "title": "JobCreate" }, "JobListResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/JobResponse" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "items", "total" ], "title": "JobListResponse" }, "JobResponse": { "properties": { "id": { "type": "integer", "title": "Id" }, "public_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Id" }, "job_type": { "type": "string", "title": "Job Type" }, "status": { "type": "string", "title": "Status" }, "stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage" }, "input_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Url" }, "template_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Id" }, "template_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Name" }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message" }, "error_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Code" }, "result_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result File Id" }, "result_ig_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Ig Caption" }, "result_slides": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Result Slides" }, "result_meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result Meta" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "finished_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Finished At" }, "delivery_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Mode" }, "get_anyway_available": { "type": "boolean", "title": "Get Anyway Available", "default": false }, "eta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Eta" }, "result_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Url" }, "result_slide_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Result Slide Urls" } }, "type": "object", "required": [ "id", "public_id", "job_type", "status", "stage", "input_url", "template_id", "template_name", "error_message", "error_code", "result_file_id", "result_ig_caption", "created_at", "finished_at", "delivery_mode" ], "title": "JobResponse" }, "KindTotals": { "properties": { "pages": { "type": "integer", "title": "Pages", "default": 0 }, "followers_delta_7d": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followers Delta 7D" }, "posts_7d": { "type": "integer", "title": "Posts 7D", "default": 0 }, "gone_or_quiet": { "type": "integer", "title": "Gone Or Quiet", "default": 0 }, "best_post_7d": { "anyOf": [ { "$ref": "#/components/schemas/api__routers__performance__PostOut" }, { "type": "null" } ] }, "best_post_handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Best Post Handle" }, "best_posts": { "items": { "$ref": "#/components/schemas/api__routers__performance__PostOut" }, "type": "array", "title": "Best Posts", "default": [] }, "best_posts_handles": { "items": { "type": "string" }, "type": "array", "title": "Best Posts Handles", "default": [] } }, "type": "object", "title": "KindTotals" }, "LookItem": { "properties": { "kind": { "type": "string", "title": "Kind" }, "title": { "type": "string", "title": "Title" }, "body": { "type": "string", "title": "Body" }, "profile_ids": { "items": { "type": "integer" }, "type": "array", "title": "Profile Ids", "default": [] } }, "type": "object", "required": [ "kind", "title", "body" ], "title": "LookItem" }, "LowFillOut": { "properties": { "pct": { "type": "integer", "title": "Pct" }, "days": { "type": "integer", "title": "Days" }, "lines": { "items": { "type": "string" }, "type": "array", "title": "Lines", "default": [] } }, "type": "object", "required": [ "pct", "days" ], "title": "LowFillOut" }, "OutputItemOut": { "properties": { "job_id": { "type": "integer", "title": "Job Id" }, "template_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Id" }, "template_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Name" }, "automation_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Automation Id" }, "automation_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Automation Name" }, "job_type": { "type": "string", "title": "Job Type" }, "finished_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Finished At" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caption" }, "source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Url" }, "file_id": { "type": "string", "title": "File Id" }, "kind": { "type": "string", "title": "Kind" }, "zippable": { "type": "boolean", "title": "Zippable" }, "expired": { "type": "boolean", "title": "Expired" }, "skipped": { "type": "boolean", "title": "Skipped", "default": false }, "slides": { "type": "integer", "title": "Slides", "default": 1 }, "download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Download Url" } }, "type": "object", "required": [ "job_id", "template_id", "template_name", "automation_id", "automation_name", "job_type", "finished_at", "caption", "source_url", "file_id", "kind", "zippable", "expired" ], "title": "OutputItemOut" }, "OutputsPageOut": { "properties": { "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "$ref": "#/components/schemas/OutputItemOut" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total", "page", "page_size", "items" ], "title": "OutputsPageOut" }, "PageDetail": { "properties": { "page": { "$ref": "#/components/schemas/PageSummary" }, "posts": { "items": { "$ref": "#/components/schemas/api__routers__performance__PostOut" }, "type": "array", "title": "Posts" }, "followers": { "items": { "$ref": "#/components/schemas/FollowerPoint" }, "type": "array", "title": "Followers" }, "what_works": { "$ref": "#/components/schemas/WhatWorks" }, "best_of_30": { "anyOf": [ { "$ref": "#/components/schemas/api__routers__performance__PostOut" }, { "type": "null" } ] }, "refresh": { "$ref": "#/components/schemas/RefreshInfo" } }, "type": "object", "required": [ "page", "posts", "followers", "what_works", "refresh" ], "title": "PageDetail" }, "PageSummary": { "properties": { "id": { "type": "integer", "title": "Id" }, "handle": { "type": "string", "title": "Handle" }, "profile_url": { "type": "string", "title": "Profile Url" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "kind": { "type": "string", "title": "Kind", "default": "own" }, "is_active": { "type": "boolean", "title": "Is Active", "default": true }, "profile_image_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Image Link" }, "status": { "type": "string", "title": "Status" }, "status_reason": { "type": "string", "title": "Status Reason" }, "metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metric" }, "typical": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Typical" }, "normal": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Normal" }, "change_pct": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Change Pct" }, "young_posts": { "type": "integer", "title": "Young Posts", "default": 0 }, "followers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followers" }, "follower_delta_7d": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Delta 7D" }, "follower_pct_7d": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Follower Pct 7D" }, "follower_span_hours": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Follower Span Hours" }, "last_post_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Post At" }, "posts_7d": { "type": "integer", "title": "Posts 7D", "default": 0 }, "posts_per_week": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Posts Per Week" }, "collab_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Collab Share" }, "followers_refreshed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Followers Refreshed At" }, "posts_refreshed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Posts Refreshed At" }, "posts_stale": { "type": "boolean", "title": "Posts Stale", "default": true }, "last_refresh_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Refresh At" }, "refresh_failure_count": { "type": "integer", "title": "Refresh Failure Count", "default": 0 }, "pending": { "type": "boolean", "title": "Pending", "default": false }, "paused": { "type": "boolean", "title": "Paused", "default": false }, "last_posts": { "items": { "$ref": "#/components/schemas/SparkPoint" }, "type": "array", "title": "Last Posts", "default": [] }, "best_post_7d": { "anyOf": [ { "$ref": "#/components/schemas/api__routers__performance__PostOut" }, { "type": "null" } ] }, "account_started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Account Started At" } }, "type": "object", "required": [ "id", "handle", "profile_url", "status", "status_reason" ], "title": "PageSummary" }, "PlanLimitsOut": { "properties": { "automations_max": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Automations Max" }, "tracked_profiles_max": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tracked Profiles Max" }, "templates_max": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Templates Max" }, "job_rpm": { "type": "integer", "title": "Job Rpm" }, "seats": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seats", "default": 1 } }, "type": "object", "required": [ "automations_max", "tracked_profiles_max", "templates_max", "job_rpm" ], "title": "PlanLimitsOut" }, "PlanOut": { "properties": { "plan": { "type": "string", "title": "Plan" }, "plan_label": { "type": "string", "title": "Plan Label" }, "features": { "items": { "$ref": "#/components/schemas/FeatureOut" }, "type": "array", "title": "Features" }, "limits": { "$ref": "#/components/schemas/PlanLimitsOut" }, "usage": { "$ref": "#/components/schemas/PlanUsageOut" }, "credit_prices": { "$ref": "#/components/schemas/CreditPricesOut" }, "next_plan": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Plan" }, "next_plan_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Plan Label" }, "plan_includes": { "items": { "type": "string" }, "type": "array", "title": "Plan Includes" }, "credit_options": { "$ref": "#/components/schemas/CreditOptionsOut" }, "next_plan_unlocks": { "items": { "type": "string" }, "type": "array", "title": "Next Plan Unlocks" }, "next_plan_highlights": { "items": { "type": "string" }, "type": "array", "title": "Next Plan Highlights" }, "payment_past_due": { "type": "boolean", "title": "Payment Past Due", "default": false }, "support": { "type": "string", "title": "Support", "default": "" }, "credits": { "anyOf": [ { "$ref": "#/components/schemas/CreditsOut" }, { "type": "null" } ] } }, "type": "object", "required": [ "plan", "plan_label", "features", "limits", "usage", "credit_prices", "next_plan", "next_plan_label", "plan_includes", "credit_options", "next_plan_unlocks", "next_plan_highlights" ], "title": "PlanOut" }, "PlanUsageOut": { "properties": { "automations_used": { "type": "integer", "title": "Automations Used" }, "tracked_profiles_used": { "type": "integer", "title": "Tracked Profiles Used" }, "templates_used": { "type": "integer", "title": "Templates Used" } }, "type": "object", "required": [ "automations_used", "tracked_profiles_used", "templates_used" ], "title": "PlanUsageOut" }, "RefreshInfo": { "properties": { "cost_credits": { "type": "integer", "title": "Cost Credits", "default": 0 }, "last_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Status" }, "last_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last At" }, "failures_30d": { "type": "integer", "title": "Failures 30D", "default": 0 } }, "type": "object", "title": "RefreshInfo" }, "RefreshStatusResponse": { "properties": { "is_refreshing": { "type": "boolean", "title": "Is Refreshing" }, "last_refresh_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Refresh At" }, "refresh_failure_count": { "type": "integer", "title": "Refresh Failure Count" }, "followers_refreshed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Followers Refreshed At" }, "posts_refreshed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Posts Refreshed At" } }, "type": "object", "required": [ "is_refreshing", "last_refresh_at", "refresh_failure_count" ], "title": "RefreshStatusResponse" }, "RouteHealth": { "properties": { "ok": { "type": "boolean", "title": "Ok" }, "missing_slots": { "items": { "type": "string" }, "type": "array", "title": "Missing Slots", "default": [] }, "ambiguous_slots": { "items": { "type": "string" }, "type": "array", "title": "Ambiguous Slots", "default": [] }, "rotating_slots": { "items": { "type": "string" }, "type": "array", "title": "Rotating Slots", "default": [] }, "no_routable": { "type": "boolean", "title": "No Routable", "default": false } }, "type": "object", "required": [ "ok" ], "title": "RouteHealth" }, "RouteOverrideIn": { "properties": { "mode": { "type": "string", "enum": [ "pin", "rotate", "random" ], "title": "Mode" }, "template_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Id" }, "exclude": { "items": { "type": "integer" }, "type": "array", "title": "Exclude", "default": [] } }, "type": "object", "required": [ "mode" ], "title": "RouteOverrideIn" }, "RunOut": { "properties": { "id": { "type": "integer", "title": "Id" }, "run_type": { "type": "string", "title": "Run Type" }, "started_at": { "type": "string", "format": "date-time", "title": "Started At" }, "finished_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Finished At" }, "status": { "type": "string", "title": "Status" }, "total_found": { "type": "integer", "title": "Total Found" }, "total_processed": { "type": "integer", "title": "Total Processed" }, "total_errors": { "type": "integer", "title": "Total Errors" }, "error_summary": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Error Summary" }, "job_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Job Count" }, "budget": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Budget" }, "why": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Why" } }, "type": "object", "required": [ "id", "run_type", "started_at", "finished_at", "status", "total_found", "total_processed", "total_errors" ], "title": "RunOut" }, "SourceHealthOut": { "properties": { "last_seen_post_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Seen Post Time" }, "recent_runs": { "items": { "$ref": "#/components/schemas/SourceRunHealth" }, "type": "array", "title": "Recent Runs", "default": [] } }, "type": "object", "title": "SourceHealthOut" }, "SourceHint": { "properties": { "profile_id": { "type": "integer", "title": "Profile Id" }, "handle": { "type": "string", "title": "Handle" }, "posts_per_week": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Posts Per Week" }, "followers": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Followers" }, "in_follower_range": { "type": "boolean", "title": "In Follower Range", "default": false }, "paid_posts": { "type": "integer", "title": "Paid Posts", "default": 0 }, "posts_checked": { "type": "integer", "title": "Posts Checked", "default": 0 } }, "type": "object", "required": [ "profile_id", "handle" ], "title": "SourceHint" }, "SourceIn": { "properties": { "platform": { "anyOf": [ { "type": "string", "enum": [ "instagram", "tiktok" ] }, { "type": "null" } ], "title": "Platform" }, "profile_url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ], "title": "Profile Url" }, "profile_username": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Profile Username" } }, "type": "object", "title": "SourceIn" }, "SourceOut": { "properties": { "id": { "type": "integer", "title": "Id" }, "platform": { "type": "string", "title": "Platform" }, "profile_url": { "type": "string", "title": "Profile Url" }, "profile_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Username" }, "last_seen_post_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Seen Post Url" }, "last_seen_post_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Seen Post Time" }, "stopped_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stopped Reason" }, "stopped_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Stopped At" }, "health": { "anyOf": [ { "$ref": "#/components/schemas/SourceHealthOut" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "platform", "profile_url", "profile_username", "last_seen_post_url", "last_seen_post_time" ], "title": "SourceOut" }, "SourceRunHealth": { "properties": { "run_id": { "type": "integer", "title": "Run Id" }, "found": { "type": "integer", "title": "Found" }, "errors_for_this_source": { "items": { "type": "string" }, "type": "array", "title": "Errors For This Source", "default": [] } }, "type": "object", "required": [ "run_id", "found" ], "title": "SourceRunHealth" }, "SparkPoint": { "properties": { "value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Value" }, "young": { "type": "boolean", "title": "Young", "default": false }, "collab": { "type": "boolean", "title": "Collab", "default": false } }, "type": "object", "title": "SparkPoint" }, "TemplateBulkRequest": { "properties": { "template_ids": { "items": { "type": "integer" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Template Ids" }, "action": { "type": "string", "enum": [ "move", "delete" ], "title": "Action" }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Folder Id" } }, "type": "object", "required": [ "template_ids", "action" ], "title": "TemplateBulkRequest" }, "TemplateCreate": { "properties": { "name": { "type": "string", "minLength": 1, "title": "Name" }, "template_type": { "type": "string", "enum": [ "twitter", "snapchat", "simple_overlay", "canvas", "tweet_rebrand", "post_rebrand" ], "title": "Template Type" }, "bg_color": { "type": "string", "enum": [ "black", "white" ], "title": "Bg Color", "default": "black" }, "bg_color_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bg Color Hex" }, "profile_pic_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic File Id" }, "profile_pic_mode": { "anyOf": [ { "type": "string", "const": "circle" }, { "type": "null" } ], "title": "Profile Pic Mode" }, "news_font_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "News Font Id" }, "news_font_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "News Font Family" }, "snap_bar_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Bar Offset Y" }, "snap_bar_padding_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Bar Padding Y" }, "snap_bar_opacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Snap Bar Opacity" }, "snap_max_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Max Lines" }, "simple_overlay_max_lines": { "anyOf": [ { "type": "integer", "maximum": 8.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Simple Overlay Max Lines" }, "ai_use_frames": { "type": "boolean", "title": "Ai Use Frames", "default": true }, "profile_safe_layout": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Profile Safe Layout" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Pinned At" }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Folder Id" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "usage_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Usage Count" }, "name_offset_x": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Name Offset X" }, "name_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Name Offset Y" }, "display_name_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Display Name Scale" }, "handle_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Handle Scale" }, "profile_pic_offset_x": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Pic Offset X" }, "profile_pic_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Pic Offset Y" }, "profile_pic_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Profile Pic Scale" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Handle" }, "tweet_prompt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tweet Prompt Text" }, "ig_caption_prompt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ig Caption Prompt Text" }, "caption_extras": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caption Extras" }, "ig_caption_enabled": { "type": "boolean", "title": "Ig Caption Enabled", "default": true }, "caption_use_source": { "type": "boolean", "title": "Caption Use Source", "default": false }, "caption_rewrite_source": { "type": "boolean", "title": "Caption Rewrite Source", "default": false }, "content_style": { "type": "string", "enum": [ "meme", "hype", "deadpan", "wholesome", "dramatic", "informative" ], "title": "Content Style", "default": "meme" }, "ai_language": { "anyOf": [ { "type": "string", "enum": [ "en", "de", "es", "pt", "fr", "it", "nl", "tr", "ar", "ja", "ko", "hi", "id", "pl", "ru", "match" ] }, { "type": "null" } ], "title": "Ai Language" }, "ai_example_lines": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Ai Example Lines" }, "ai_emoji_level": { "anyOf": [ { "type": "string", "enum": [ "none", "some", "lots" ] }, { "type": "null" } ], "title": "Ai Emoji Level" }, "ai_lowercase": { "type": "boolean", "title": "Ai Lowercase", "default": false }, "ai_banned_words": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Ai Banned Words" }, "ai_end_question": { "type": "boolean", "title": "Ai End Question", "default": false }, "ig_hashtag_count": { "anyOf": [ { "type": "integer", "maximum": 15.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Ig Hashtag Count" }, "ig_hashtags_custom": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Ig Hashtags Custom" }, "tweet_text_mode": { "type": "string", "enum": [ "ai", "fixed", "manual", "none" ], "title": "Tweet Text Mode", "default": "ai" }, "tweet_text_fixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tweet Text Fixed" }, "tweet_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tweet Verified" }, "tweet_rebrand_mode": { "anyOf": [ { "type": "string", "const": "rebuild" }, { "type": "null" } ], "title": "Tweet Rebrand Mode" }, "post_look": { "anyOf": [ { "type": "string", "enum": [ "classic", "bold", "story", "panel", "mag", "html" ] }, { "type": "null" } ], "title": "Post Look" }, "slide_text_style": { "anyOf": [ { "type": "string", "enum": [ "native", "box", "bar" ] }, { "type": "null" } ], "title": "Slide Text Style" }, "slide_pic_style": { "anyOf": [ { "type": "string", "enum": [ "keep", "blur", "frame", "strip" ] }, { "type": "null" } ], "title": "Slide Pic Style" }, "end_slide_when": { "anyOf": [ { "type": "string", "enum": [ "always", "replace", "never" ] }, { "type": "null" } ], "title": "End Slide When" }, "end_slide_style": { "anyOf": [ { "type": "string", "enum": [ "dark", "block", "blur", "profile", "save", "split", "bigfollow", "next" ] }, { "type": "null" } ], "title": "End Slide Style" }, "slide_num_style": { "anyOf": [ { "type": "string", "enum": [ "plain", "big" ] }, { "type": "null" } ], "title": "Slide Num Style" }, "slide_frame_bg": { "anyOf": [ { "type": "string", "enum": [ "black", "blur" ] }, { "type": "null" } ], "title": "Slide Frame Bg" }, "other_slides": { "anyOf": [ { "type": "string", "enum": [ "restyle", "as_they_came", "leave_out" ] }, { "type": "null" } ], "title": "Other Slides" }, "end_slide_line": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ], "title": "End Slide Line" }, "posted_button_enabled": { "type": "boolean", "title": "Posted Button Enabled", "default": false }, "workspace_topic_opt_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Workspace Topic Opt In" }, "workspace_topic_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Topic Scope" }, "canvas_elements": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Canvas Elements" }, "canvas_width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Canvas Width" }, "canvas_height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Canvas Height" }, "canvas_bg_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Canvas Bg Color" } }, "type": "object", "required": [ "name", "template_type" ], "title": "TemplateCreate" }, "TemplateResponse": { "properties": { "id": { "type": "integer", "title": "Id" }, "public_id": { "type": "string", "title": "Public Id" }, "share_enabled": { "type": "boolean", "title": "Share Enabled", "default": false }, "shared_org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Shared Org Id" }, "name": { "type": "string", "title": "Name" }, "template_type": { "type": "string", "title": "Template Type" }, "bg_color": { "type": "string", "title": "Bg Color" }, "bg_color_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bg Color Hex" }, "profile_pic_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic File Id" }, "profile_pic_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic Mode" }, "news_font_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "News Font Id" }, "news_font_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "News Font Family" }, "snap_bar_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Bar Offset Y" }, "snap_bar_padding_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Bar Padding Y" }, "snap_bar_opacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Snap Bar Opacity" }, "snap_max_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Max Lines" }, "simple_overlay_max_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Simple Overlay Max Lines" }, "ai_use_frames": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ai Use Frames" }, "profile_safe_layout": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Profile Safe Layout" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Pinned At" }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Folder Id" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "usage_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Usage Count" }, "name_offset_x": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Name Offset X" }, "name_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Name Offset Y" }, "display_name_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Display Name Scale" }, "handle_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Handle Scale" }, "profile_pic_offset_x": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Pic Offset X" }, "profile_pic_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Pic Offset Y" }, "profile_pic_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Profile Pic Scale" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Handle" }, "tweet_prompt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tweet Prompt Text" }, "ig_caption_prompt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ig Caption Prompt Text" }, "caption_extras": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caption Extras" }, "ig_caption_enabled": { "type": "boolean", "title": "Ig Caption Enabled", "default": true }, "caption_use_source": { "type": "boolean", "title": "Caption Use Source", "default": false }, "caption_rewrite_source": { "type": "boolean", "title": "Caption Rewrite Source", "default": false }, "content_style": { "type": "string", "title": "Content Style" }, "ai_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ai Language" }, "ai_example_lines": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ai Example Lines" }, "ai_emoji_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ai Emoji Level" }, "ai_lowercase": { "type": "boolean", "title": "Ai Lowercase", "default": false }, "ai_banned_words": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ai Banned Words" }, "ai_end_question": { "type": "boolean", "title": "Ai End Question", "default": false }, "ig_hashtag_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ig Hashtag Count" }, "ig_hashtags_custom": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ig Hashtags Custom" }, "tweet_text_mode": { "type": "string", "title": "Tweet Text Mode" }, "tweet_text_fixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tweet Text Fixed" }, "tweet_verified": { "type": "boolean", "title": "Tweet Verified", "default": true }, "tweet_rebrand_mode": { "type": "string", "title": "Tweet Rebrand Mode", "default": "rebuild" }, "post_look": { "type": "string", "title": "Post Look", "default": "classic" }, "page_design_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Page Design Id" }, "slide_text_style": { "type": "string", "title": "Slide Text Style", "default": "native" }, "slide_pic_style": { "type": "string", "title": "Slide Pic Style", "default": "keep" }, "end_slide_when": { "type": "string", "title": "End Slide When", "default": "replace" }, "end_slide_style": { "type": "string", "title": "End Slide Style", "default": "dark" }, "slide_num_style": { "type": "string", "title": "Slide Num Style", "default": "plain" }, "slide_frame_bg": { "type": "string", "title": "Slide Frame Bg", "default": "black" }, "other_slides": { "type": "string", "title": "Other Slides", "default": "as_they_came" }, "end_slide_line": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Slide Line" }, "destination_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Id" }, "posted_button_enabled": { "type": "boolean", "title": "Posted Button Enabled" }, "workspace_topic_opt_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Workspace Topic Opt In" }, "workspace_topic_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Topic Scope" }, "hidden_in_workspace": { "type": "boolean", "title": "Hidden In Workspace", "default": false }, "canvas_elements": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Canvas Elements" }, "canvas_width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Canvas Width" }, "canvas_height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Canvas Height" }, "canvas_bg_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Canvas Bg Color" }, "route_slot": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Route Slot" }, "credit_cost": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Credit Cost" }, "automation_count": { "type": "integer", "title": "Automation Count", "default": 0 }, "page_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Color" }, "canvas_rev": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Canvas Rev" } }, "type": "object", "required": [ "id", "public_id", "name", "template_type", "bg_color", "content_style", "tweet_text_mode", "posted_button_enabled" ], "title": "TemplateResponse" }, "TemplateUpdate": { "properties": { "if_canvas_rev": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "If Canvas Rev" }, "name": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "template_type": { "anyOf": [ { "type": "string", "enum": [ "twitter", "snapchat", "simple_overlay", "canvas", "tweet_rebrand", "post_rebrand" ] }, { "type": "null" } ], "title": "Template Type" }, "bg_color": { "anyOf": [ { "type": "string", "enum": [ "black", "white" ] }, { "type": "null" } ], "title": "Bg Color" }, "bg_color_hex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bg Color Hex" }, "profile_pic_file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Pic File Id" }, "profile_pic_mode": { "anyOf": [ { "type": "string", "const": "circle" }, { "type": "null" } ], "title": "Profile Pic Mode" }, "news_font_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "News Font Id" }, "news_font_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "News Font Family" }, "snap_bar_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Bar Offset Y" }, "snap_bar_padding_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Bar Padding Y" }, "snap_bar_opacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Snap Bar Opacity" }, "snap_max_lines": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Snap Max Lines" }, "simple_overlay_max_lines": { "anyOf": [ { "type": "integer", "maximum": 8.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Simple Overlay Max Lines" }, "ai_use_frames": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ai Use Frames" }, "profile_safe_layout": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Profile Safe Layout" }, "pinned_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Pinned At" }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Folder Id" }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Used At" }, "usage_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Usage Count" }, "name_offset_x": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Name Offset X" }, "name_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Name Offset Y" }, "display_name_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Display Name Scale" }, "handle_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Handle Scale" }, "profile_pic_offset_x": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Pic Offset X" }, "profile_pic_offset_y": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Profile Pic Offset Y" }, "profile_pic_scale": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Profile Pic Scale" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Handle" }, "tweet_prompt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tweet Prompt Text" }, "ig_caption_prompt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ig Caption Prompt Text" }, "caption_extras": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caption Extras" }, "ig_caption_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ig Caption Enabled" }, "caption_use_source": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Caption Use Source" }, "caption_rewrite_source": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Caption Rewrite Source" }, "content_style": { "anyOf": [ { "type": "string", "enum": [ "meme", "hype", "deadpan", "wholesome", "dramatic", "informative" ] }, { "type": "null" } ], "title": "Content Style" }, "ai_language": { "anyOf": [ { "type": "string", "enum": [ "en", "de", "es", "pt", "fr", "it", "nl", "tr", "ar", "ja", "ko", "hi", "id", "pl", "ru", "match" ] }, { "type": "null" } ], "title": "Ai Language" }, "ai_example_lines": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ], "title": "Ai Example Lines" }, "ai_emoji_level": { "anyOf": [ { "type": "string", "enum": [ "none", "some", "lots" ] }, { "type": "null" } ], "title": "Ai Emoji Level" }, "ai_lowercase": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ai Lowercase" }, "ai_banned_words": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ], "title": "Ai Banned Words" }, "ai_end_question": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ai End Question" }, "ig_hashtag_count": { "anyOf": [ { "type": "integer", "maximum": 15.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Ig Hashtag Count" }, "ig_hashtags_custom": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Ig Hashtags Custom" }, "tweet_text_mode": { "anyOf": [ { "type": "string", "enum": [ "ai", "fixed", "manual", "none" ] }, { "type": "null" } ], "title": "Tweet Text Mode" }, "tweet_text_fixed": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tweet Text Fixed" }, "tweet_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Tweet Verified" }, "tweet_rebrand_mode": { "anyOf": [ { "type": "string", "const": "rebuild" }, { "type": "null" } ], "title": "Tweet Rebrand Mode" }, "post_look": { "anyOf": [ { "type": "string", "enum": [ "classic", "bold", "story", "panel", "mag", "html" ] }, { "type": "null" } ], "title": "Post Look" }, "slide_text_style": { "anyOf": [ { "type": "string", "enum": [ "native", "box", "bar" ] }, { "type": "null" } ], "title": "Slide Text Style" }, "slide_pic_style": { "anyOf": [ { "type": "string", "enum": [ "keep", "blur", "frame", "strip" ] }, { "type": "null" } ], "title": "Slide Pic Style" }, "end_slide_when": { "anyOf": [ { "type": "string", "enum": [ "always", "replace", "never" ] }, { "type": "null" } ], "title": "End Slide When" }, "end_slide_style": { "anyOf": [ { "type": "string", "enum": [ "dark", "block", "blur", "profile", "save", "split", "bigfollow", "next" ] }, { "type": "null" } ], "title": "End Slide Style" }, "slide_num_style": { "anyOf": [ { "type": "string", "enum": [ "plain", "big" ] }, { "type": "null" } ], "title": "Slide Num Style" }, "slide_frame_bg": { "anyOf": [ { "type": "string", "enum": [ "black", "blur" ] }, { "type": "null" } ], "title": "Slide Frame Bg" }, "other_slides": { "anyOf": [ { "type": "string", "enum": [ "restyle", "as_they_came", "leave_out" ] }, { "type": "null" } ], "title": "Other Slides" }, "end_slide_line": { "anyOf": [ { "type": "string", "maxLength": 40 }, { "type": "null" } ], "title": "End Slide Line" }, "posted_button_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Posted Button Enabled" }, "workspace_topic_opt_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Workspace Topic Opt In" }, "workspace_topic_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Topic Scope" }, "hidden_in_workspace": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hidden In Workspace" }, "destination_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Destination Id" }, "canvas_elements": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Canvas Elements" }, "canvas_width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Canvas Width" }, "canvas_height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Canvas Height" }, "canvas_bg_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Canvas Bg Color" } }, "type": "object", "title": "TemplateUpdate" }, "TopupPackOut": { "properties": { "id": { "type": "string", "title": "Id" }, "price_usd": { "type": "integer", "title": "Price Usd" }, "credits": { "type": "integer", "title": "Credits" }, "available": { "type": "boolean", "title": "Available", "default": true } }, "type": "object", "required": [ "id", "price_usd", "credits" ], "title": "TopupPackOut" }, "UsageOut": { "properties": { "period_label": { "type": "string", "title": "Period Label" }, "creates": { "type": "integer", "title": "Creates" }, "downloads": { "type": "integer", "title": "Downloads" }, "crops": { "type": "integer", "title": "Crops" }, "credits_spent": { "type": "integer", "title": "Credits Spent" } }, "type": "object", "required": [ "period_label", "creates", "downloads", "crops", "credits_spent" ], "title": "UsageOut" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "WatchingFeedResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/FeedItem" }, "type": "array", "title": "Items" }, "hints": { "items": { "$ref": "#/components/schemas/SourceHint" }, "type": "array", "title": "Hints" } }, "type": "object", "required": [ "items", "hints" ], "title": "WatchingFeedResponse" }, "WhatWorks": { "properties": { "length": { "items": { "$ref": "#/components/schemas/WorksBar" }, "type": "array", "title": "Length", "default": [] }, "collab": { "items": { "$ref": "#/components/schemas/WorksBar" }, "type": "array", "title": "Collab", "default": [] }, "format": { "items": { "$ref": "#/components/schemas/WorksBar" }, "type": "array", "title": "Format", "default": [] } }, "type": "object", "title": "WhatWorks" }, "WorksBar": { "properties": { "label": { "type": "string", "title": "Label" }, "posts": { "type": "integer", "title": "Posts" }, "multiple": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Multiple" } }, "type": "object", "required": [ "label", "posts" ], "title": "WorksBar" }, "api__routers__automations__schemas__DestinationOut": { "properties": { "id": { "type": "integer", "title": "Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" } }, "type": "object", "required": [ "id" ], "title": "DestinationOut" }, "api__routers__performance__OverviewResponse": { "properties": { "pages": { "items": { "$ref": "#/components/schemas/PageSummary" }, "type": "array", "title": "Pages" }, "own": { "$ref": "#/components/schemas/KindTotals" }, "watching": { "$ref": "#/components/schemas/KindTotals" }, "used": { "type": "integer", "title": "Used" }, "cap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cap" }, "followers_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Followers Updated At" }, "posts_updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Posts Updated At" }, "needs_a_look": { "items": { "$ref": "#/components/schemas/LookItem" }, "type": "array", "title": "Needs A Look", "default": [] }, "refresh_cost_credits": { "type": "integer", "title": "Refresh Cost Credits", "default": 0 } }, "type": "object", "required": [ "pages", "own", "watching", "used" ], "title": "OverviewResponse" }, "api__routers__performance__PostOut": { "properties": { "code": { "type": "string", "title": "Code" }, "url": { "type": "string", "title": "Url" }, "posted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Posted At" }, "post_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Type" }, "views": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views" }, "likes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Likes" }, "comments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comments" }, "is_collab": { "type": "boolean", "title": "Is Collab", "default": false }, "coauthor_handles": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Coauthor Handles" }, "is_pinned": { "type": "boolean", "title": "Is Pinned", "default": false }, "is_paid": { "type": "boolean", "title": "Is Paid", "default": false }, "length_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Length Seconds" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caption" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url" }, "stats_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Stats At" }, "young": { "type": "boolean", "title": "Young", "default": false }, "multiple": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Multiple" }, "value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Value" }, "value_1d": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Value 1D" }, "value_2d": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Value 2D" }, "value_7d": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Value 7D" } }, "type": "object", "required": [ "code", "url" ], "title": "PostOut" } }, "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "description": "An API key (sx_live_...)" } } }, "security": [ { "apiKey": [] } ], "paths": { "/v1/account/plan": { "get": { "tags": [ "account" ], "summary": "Your plan and credits", "description": "Plan, credit balance, and what each kind of post costs you.", "operationId": "plan_overview_account_plan_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/account/usage": { "get": { "tags": [ "account" ], "summary": "Your usage", "description": "What you have used this period.", "operationId": "usage_this_period_account_usage_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/automations": { "get": { "tags": [ "automations" ], "summary": "List automations", "description": "Your automations with their settings and state.", "operationId": "list_automations_automations_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationOut" }, "title": "Response List Automations Automations Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "automations:read" }, "post": { "tags": [ "automations" ], "summary": "Create an automation", "operationId": "create_automation_automations_post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Make a new automation. Easier on the website; see the automations guide.", "x-socialix-scope": "automations:write" } }, "/v1/automations/limits": { "get": { "tags": [ "automations" ], "summary": "Automation limits", "description": "How many automations your plan allows and how many you use.", "operationId": "get_automation_limits_automations_limits_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationLimitsOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "automations:read" } }, "/v1/automations/{automation_id}": { "get": { "tags": [ "automations" ], "summary": "Get an automation", "operationId": "get_automation_automations__automation_id__get", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Automation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "One of your automations.", "x-socialix-scope": "automations:read" }, "patch": { "tags": [ "automations" ], "summary": "Change an automation", "operationId": "update_automation_automations__automation_id__patch", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Automation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Change settings, or pause and resume it with enabled false or true.", "x-socialix-scope": "automations:write" }, "delete": { "tags": [ "automations" ], "summary": "Delete an automation", "operationId": "delete_automation_automations__automation_id__delete", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Automation Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Delete one of your automations.", "x-socialix-scope": "automations:write" } }, "/v1/automations/{automation_id}/outputs": { "get": { "tags": [ "automations" ], "summary": "Posts from an automation", "description": "The posts an automation made.", "operationId": "list_outputs_automations__automation_id__outputs_get", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Automation Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationOutput" }, "title": "Response List Outputs Automations Automation Id Outputs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "automations:read" } }, "/v1/automations/{automation_id}/run-now": { "post": { "tags": [ "automations" ], "summary": "Run an automation now", "description": "Start a run right away. Its posts cost credits like any post.", "operationId": "run_automation_now_automations__automation_id__run_now_post", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Automation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "automations:write" } }, "/v1/automations/{automation_id}/runs": { "get": { "tags": [ "automations" ], "summary": "Automation runs", "operationId": "list_runs_automations__automation_id__runs_get", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Automation Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RunOut" }, "title": "Response List Runs Automations Automation Id Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "The recent runs of an automation and what each one did.", "x-socialix-scope": "automations:read" } }, "/v1/automations/{automation_id}/runs/{run_id}/retry-failed": { "post": { "tags": [ "automations" ], "summary": "Retry a run's failed posts", "description": "Try the failed posts of a run again. They cost credits again; failed posts were refunded.", "operationId": "retry_failed_run_outputs_automations__automation_id__runs__run_id__retry_failed_post", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Automation Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "automations:write" } }, "/v1/files/kind/{file_id}": { "get": { "tags": [ "files" ], "summary": "Is a file a video or a picture", "description": "Answers image, video or unknown. Unknown is a real answer: most file ids carry no extension.", "operationId": "get_file_kind_files_kind__file_id__get", "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/files/s/{token}": { "get": { "tags": [ "files" ], "summary": "Download through a signed link", "description": "The file behind a result_url or download_url. Needs no key; the link stops working after about an hour.", "operationId": "get_signed_file_files_s__token__get", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string", "title": "Token" } }, { "name": "w", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 4096, "minimum": 1 }, { "type": "null" } ], "description": "Draw width, as on /files/{file_id}.", "title": "W" }, "description": "Draw width, as on /files/{file_id}." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/files/{file_id}": { "get": { "tags": [ "files" ], "summary": "Download a file", "description": "The bytes of one of your results, with its real content type. Add w to get a smaller preview picture.", "operationId": "get_file_files__file_id__get", "parameters": [ { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } }, { "name": "w", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 4096, "minimum": 1 }, { "type": "null" } ], "description": "Draw width in device pixels. Serves a cached WebP thumbnail instead of the full render. Use it for grid and list tiles. Ignored for video and for images already smaller than w.", "title": "W" }, "description": "Draw width in device pixels. Serves a cached WebP thumbnail instead of the full render. Use it for grid and list tiles. Ignored for video and for images already smaller than w." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/jobs/": { "post": { "tags": [ "jobs" ], "summary": "Make a post", "description": "Turn a link (or your own uploaded media) into a post with one of your templates. Send an Idempotency-Key. Costs credits.", "operationId": "create_job_jobs__post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" }, "get": { "tags": [ "jobs" ], "summary": "List posts", "description": "Your posts, newest first. To watch for finished posts use template_ids, finished_since and order=oldest.", "operationId": "list_jobs_jobs__get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "default": 20, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "job_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Job Type" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "template_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Id" } }, { "name": "template_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated template IDs. Use instead of template_id to watch several templates in one call.", "title": "Template Ids" }, "description": "Comma-separated template IDs. Use instead of template_id to watch several templates in one call." }, { "name": "finished_since", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO-8601 timestamp. Only jobs that finished at or after it. Pair with order=oldest to walk forward with a cursor.", "title": "Finished Since" }, "description": "ISO-8601 timestamp. Only jobs that finished at or after it. Pair with order=oldest to walk forward with a cursor." }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "description": "newest (default) or oldest. Use oldest when advancing a finished_since cursor, so nothing is skipped.", "default": "newest", "title": "Order" }, "description": "newest (default) or oldest. Use oldest when advancing a finished_since cursor, so nothing is skipped." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/jobs/batch": { "post": { "tags": [ "jobs" ], "summary": "Make many posts", "description": "Up to 50 links into one Post Rebrand template in one call. Each post costs credits.", "operationId": "create_batch_jobs_batch_post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" } }, "/v1/jobs/batch/{batch_id}": { "get": { "tags": [ "jobs" ], "summary": "Progress of a batch", "description": "How many posts of a batch are done, failed or still running.", "operationId": "get_batch_status_jobs_batch__batch_id__get", "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Batch Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/jobs/crop": { "post": { "tags": [ "jobs" ], "summary": "Crop a video", "description": "Download a video and crop it to 9:16.", "operationId": "create_crop_job_jobs_crop_post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CropJobCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" } }, "/v1/jobs/download": { "post": { "tags": [ "jobs" ], "summary": "Download a source", "description": "Download the media of a link, unchanged.", "operationId": "create_download_job_jobs_download_post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadJobCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" } }, "/v1/jobs/fanout": { "post": { "tags": [ "jobs" ], "summary": "One link, several templates", "description": "Make one post per template from the same link. Each post costs credits.", "operationId": "create_fanout_jobs_fanout_post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FanoutCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FanoutResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" } }, "/v1/jobs/source-probe": { "get": { "tags": [ "jobs" ], "summary": "What a link holds", "description": "Whether a link is a video, a photo or a gallery, where we can tell.", "operationId": "probe_source_media_jobs_source_probe_get", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Probe Source Media Jobs Source Probe Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/jobs/thumbnail": { "get": { "tags": [ "jobs" ], "summary": "Preview picture of a link", "description": "A preview picture address for a video link, where the platform offers one.", "operationId": "get_video_thumbnail_jobs_thumbnail_get", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "title": "Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Get Video Thumbnail Jobs Thumbnail Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/jobs/typical-duration": { "get": { "tags": [ "jobs" ], "summary": "Typical time per kind of job", "description": "How long each kind of job usually takes, in seconds.", "operationId": "typical_duration_jobs_typical_duration_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer" }, "title": "Response Typical Duration Jobs Typical Duration Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/jobs/{job_id}": { "get": { "tags": [ "jobs" ], "summary": "Get a post", "description": "One post: status, the error if it failed, and result_url when it is done.", "operationId": "get_job_jobs__job_id__get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/jobs/{job_id}/cancel": { "post": { "tags": [ "jobs" ], "summary": "Cancel a post", "description": "Stop a post that is still waiting or running. Its credits come back.", "operationId": "cancel_job_jobs__job_id__cancel_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" } }, "/v1/jobs/{job_id}/get-anyway": { "post": { "tags": [ "jobs" ], "summary": "Get a refused cover anyway", "description": "Make a cover our check refused, when the post says it is available. Costs credits.", "operationId": "get_it_anyway_jobs__job_id__get_anyway_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" } }, "/v1/jobs/{job_id}/retry": { "post": { "tags": [ "jobs" ], "summary": "Retry a failed post", "description": "Make a failed post again. Costs credits like a new post.", "operationId": "retry_job_jobs__job_id__retry_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" } }, "/v1/jobs/{job_id}/stream": { "get": { "tags": [ "jobs" ], "summary": "Live progress of a post", "description": "Server-sent events while a post runs. Polling GET /jobs/{job_id} or a webhook is simpler.", "operationId": "stream_job_jobs__job_id__stream_get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } }, { "name": "last_event_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Event Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "text/event-stream": { "itemSchema": { "type": "object", "properties": { "data": { "type": "string" }, "event": { "type": "string" }, "id": { "type": "string" }, "retry": { "type": "integer", "minimum": 0 } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/performance/highlights": { "get": { "tags": [ "performance" ], "summary": "Page highlights", "description": "The best recent posts of the pages you track.", "operationId": "highlights_performance_highlights_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HighlightsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/performance/overview": { "get": { "tags": [ "performance" ], "summary": "Page stats overview", "description": "How the pages you track did.", "operationId": "overview_performance_overview_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api__routers__performance__OverviewResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/performance/pages/{profile_id}": { "get": { "tags": [ "performance" ], "summary": "One page's stats", "description": "Stats of one tracked page.", "operationId": "page_detail_performance_pages__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Profile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageDetail" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/performance/profiles": { "get": { "tags": [ "performance" ], "summary": "Tracked pages", "description": "The pages you track.", "operationId": "list_profiles_performance_profiles_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PageSummary" }, "title": "Response List Profiles Performance Profiles Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/performance/profiles/{profile_id}": { "get": { "tags": [ "performance" ], "summary": "A tracked page", "operationId": "get_profile_performance_profiles__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Profile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageSummary" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "One tracked page.", "x-socialix-scope": "account:read" } }, "/v1/performance/profiles/{profile_id}/follower-history": { "get": { "tags": [ "performance" ], "summary": "Follower history", "description": "Followers over time for a tracked page.", "operationId": "follower_history_performance_profiles__profile_id__follower_history_get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Profile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FollowerHistoryEntry" }, "title": "Response Follower History Performance Profiles Profile Id Follower History Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/performance/profiles/{profile_id}/reels": { "get": { "tags": [ "performance" ], "summary": "A page's posts", "description": "Recent posts of a tracked page with their numbers.", "operationId": "list_reels_performance_profiles__profile_id__reels_get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Profile Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/api__routers__performance__PostOut" }, "title": "Response List Reels Performance Profiles Profile Id Reels Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/performance/profiles/{profile_id}/refresh-status": { "get": { "tags": [ "performance" ], "summary": "Refresh state", "operationId": "refresh_status_performance_profiles__profile_id__refresh_status_get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Profile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "When a tracked page was last refreshed.", "x-socialix-scope": "account:read" } }, "/v1/performance/watching/feed": { "get": { "tags": [ "performance" ], "summary": "Watched pages feed", "description": "Recent posts of the pages you watch.", "operationId": "watching_feed_performance_watching_feed_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatchingFeedResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "account:read" } }, "/v1/templates/": { "get": { "tags": [ "templates" ], "summary": "List templates", "description": "Your templates. Use an id from here when you make a post.", "operationId": "list_templates_templates__get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateResponse" }, "title": "Response List Templates Templates Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:read" }, "post": { "tags": [ "templates" ], "summary": "Create a template", "description": "Make a template. Templates are easiest to build on the website; copy one there and adjust it.", "operationId": "create_template_templates__post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" } }, "/v1/templates/bulk": { "post": { "tags": [ "templates" ], "summary": "Move or delete templates", "description": "Move several templates to a folder, or delete them.", "operationId": "bulk_templates_templates_bulk_post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateBulkRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Bulk Templates Templates Bulk Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" } }, "/v1/templates/folders": { "get": { "tags": [ "templates" ], "summary": "Template folders", "description": "Your template folders.", "operationId": "list_folders_templates_folders_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FolderResponse" }, "title": "Response List Folders Templates Folders Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:read" }, "post": { "tags": [ "templates" ], "summary": "Create a folder", "description": "Make a template folder.", "operationId": "create_folder_templates_folders_post", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderCreate" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" } }, "/v1/templates/folders/{folder_id}": { "patch": { "tags": [ "templates" ], "summary": "Rename a folder", "description": "Change a template folder.", "operationId": "rename_folder_templates_folders__folder_id__patch", "parameters": [ { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Folder Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" }, "delete": { "tags": [ "templates" ], "summary": "Delete a folder", "description": "Delete a template folder. Its templates stay.", "operationId": "delete_folder_templates_folders__folder_id__delete", "parameters": [ { "name": "folder_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Folder Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Folder Templates Folders Folder Id Delete" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" } }, "/v1/templates/post-rebrand/settings": { "get": { "tags": [ "templates" ], "summary": "Post Rebrand settings", "description": "The choices a Post Rebrand template offers.", "operationId": "post_rebrand_settings_templates_post_rebrand_settings_get", "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Post Rebrand Settings Templates Post Rebrand Settings Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:read" } }, "/v1/templates/{template_id}": { "get": { "tags": [ "templates" ], "summary": "Get a template", "description": "One of your templates with all its settings.", "operationId": "get_template_templates__template_id__get", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Template Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:read" }, "patch": { "tags": [ "templates" ], "summary": "Change a template", "description": "Change a template's settings.", "operationId": "update_template_templates__template_id__patch", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Template Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" }, "delete": { "tags": [ "templates" ], "summary": "Delete a template", "description": "Delete one of your templates.", "operationId": "delete_template_templates__template_id__delete", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Template Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" } }, "/v1/templates/{template_id}/duplicate": { "post": { "tags": [ "templates" ], "summary": "Copy a template", "description": "Make a copy of one of your templates.", "operationId": "duplicate_template_templates__template_id__duplicate_post", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Template Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" } }, "/v1/templates/{template_id}/pin": { "post": { "tags": [ "templates" ], "summary": "Pin a template", "description": "Pin or unpin a template in your list.", "operationId": "toggle_pin_template_templates__template_id__pin_post", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Template Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:write" } }, "/v1/templates/{template_id}/thumbnail": { "get": { "tags": [ "templates" ], "summary": "Template preview picture", "description": "A preview picture of a template.", "operationId": "template_thumbnail_templates__template_id__thumbnail_get", "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Template Id" } }, { "name": "w", "in": "query", "required": false, "schema": { "type": "integer", "description": "Output width in px (clamped to 64-640)", "default": 320, "title": "W" }, "description": "Output width in px (clamped to 64-640)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "templates:read" } }, "/v1/uploads/": { "post": { "tags": [ "uploads" ], "summary": "Upload a picture or video", "description": "Send your own media. Use the address it returns in picture_urls or video_urls when you make a post.", "operationId": "upload_file_uploads__post", "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_file_uploads__post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:write" } }, "/v1/uploads/{filename}": { "get": { "tags": [ "uploads" ], "summary": "Get an upload", "description": "A file you uploaded.", "operationId": "get_upload_uploads__filename__get", "parameters": [ { "name": "filename", "in": "path", "required": true, "schema": { "type": "string", "title": "Filename" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } }, "/v1/workspace/outputs": { "get": { "tags": [ "workspace" ], "summary": "Your library", "description": "Every finished post, newest first, with a download_url for each.", "operationId": "workspace_outputs_workspace_outputs_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 60, "minimum": 1, "default": 24, "title": "Page Size" } }, { "name": "template_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Template Id" } }, { "name": "source", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(all|automation|manual)$", "default": "all", "title": "Source" } }, { "name": "days", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 365, "minimum": 1 }, { "type": "null" } ], "title": "Days" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputsPageOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-socialix-scope": "jobs:read" } } } }