Base address https://socialix.ai/api; the paths below start with /v1. This list is complete: anything not on it does not exist for API keys. Fields marked required must be sent; a field that takes fixed words lists all of them.

Account

GET/v1/account/planaccount:read
Your plan and credits. Plan, credit balance, and what each kind of post costs you.
GET/v1/account/usageaccount:read
Your usage. What you have used this period.

Page stats

GET/v1/performance/highlightsaccount:read
Page highlights. The best recent posts of the pages you track.
GET/v1/performance/overviewaccount:read
Page stats overview. How the pages you track did.
GET/v1/performance/pages/{profile_id}account:read
One page's stats. Stats of one tracked page.
  • profile_id (path, number)required
GET/v1/performance/profilesaccount:read
Tracked pages. The pages you track.
GET/v1/performance/profiles/{profile_id}account:read
A tracked page. One tracked page.
  • profile_id (path, number)required
GET/v1/performance/profiles/{profile_id}/follower-historyaccount:read
Follower history. Followers over time for a tracked page.
  • profile_id (path, number)required
GET/v1/performance/profiles/{profile_id}/reelsaccount:read
A page's posts. Recent posts of a tracked page with their numbers.
  • profile_id (path, number)required
  • limit (query, number)
GET/v1/performance/profiles/{profile_id}/refresh-statusaccount:read
Refresh state. When a tracked page was last refreshed.
  • profile_id (path, number)required
GET/v1/performance/watching/feedaccount:read
Watched pages feed. Recent posts of the pages you watch.

Automations

GET/v1/automationsautomations:read
List automations. Your automations with their settings and state.
GET/v1/automations/limitsautomations:read
Automation limits. How many automations your plan allows and how many you use.
GET/v1/automations/{automation_id}automations:read
Get an automation. One of your automations.
  • automation_id (path, number)required
GET/v1/automations/{automation_id}/outputsautomations:read
Posts from an automation. The posts an automation made.
  • automation_id (path, number)required
  • limit (query, number)
  • run_id (query, number or empty)
GET/v1/automations/{automation_id}/runsautomations:read
Automation runs. The recent runs of an automation and what each one did.
  • automation_id (path, number)required
  • limit (query, number)
POST/v1/automationsautomations:write
Create an automation. Make a new automation. Easier on the website; see the automations guide.
  • name (string)required
  • template_id (number or empty)
  • folder_id (number or empty)
  • route_overrides (object or empty)
  • run_hour (number)required
  • run_minute (number)required
  • max_posts_per_day (number)
  • always_crop (true/false)
  • enabled (true/false)
  • workspace_topic_opt_in (true/false or empty)
  • workspace_topic_scope (string or empty)
  • sources (list of any)required
DELETE/v1/automations/{automation_id}automations:write
Delete an automation. Delete one of your automations.
  • automation_id (path, number)required
PATCH/v1/automations/{automation_id}automations:write
Change an automation. Change settings, or pause and resume it with enabled false or true.
  • automation_id (path, number)required
  • name (string or empty)
  • template_id (number or empty)
  • folder_id (number or empty)
  • route_overrides (object or empty)
  • run_hour (number or empty)
  • run_minute (number or empty)
  • max_posts_per_day (number or empty)
  • always_crop (true/false or empty)
  • enabled (true/false or empty)
  • workspace_topic_opt_in (true/false or empty)
  • workspace_topic_scope (string or empty)
  • destination_id (number or empty)
  • sources (list of any or empty)
POST/v1/automations/{automation_id}/run-nowautomations:write
Run an automation now. Start a run right away. Its posts cost credits like any post.
  • automation_id (path, number)required
POST/v1/automations/{automation_id}/runs/{run_id}/retry-failedautomations:write
Retry a run's failed posts. Try the failed posts of a run again. They cost credits again; failed posts were refunded.
  • automation_id (path, number)required
  • run_id (path, number)required

Files

GET/v1/files/kind/{file_id}jobs:read
Is a file a video or a picture. Answers image, video or unknown. Unknown is a real answer: most file ids carry no extension.
  • file_id (path, string)required
GET/v1/files/s/{token}jobs:read
Download through a signed link. The file behind a result_url or download_url. Needs no key; the link stops working after about an hour.
  • token (path, string)required
  • w (query, number or empty): Draw width, as on /files/{file_id}.
GET/v1/files/{file_id}jobs:read
Download a file. The bytes of one of your results, with its real content type. Add w to get a smaller preview picture.
  • file_id (path, string)required
  • w (query, number or empty): 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.

Posts

GET/v1/jobs/jobs:read
List posts. Your posts, newest first. To watch for finished posts use template_ids, finished_since and order=oldest.
  • limit (query, number)
  • offset (query, number)
  • job_type (query, string or empty)
  • status (query, string or empty)
  • template_id (query, number or empty)
  • template_ids (query, string or empty): Comma-separated template IDs. Use instead of template_id to watch several templates in one call.
  • finished_since (query, string or empty): ISO-8601 timestamp. Only jobs that finished at or after it. Pair with order=oldest to walk forward with a cursor.
  • order (query, string): newest (default) or oldest. Use oldest when advancing a finished_since cursor, so nothing is skipped.
GET/v1/jobs/batch/{batch_id}jobs:read
Progress of a batch. How many posts of a batch are done, failed or still running.
  • batch_id (path, string)required
GET/v1/jobs/source-probejobs:read
What a link holds. Whether a link is a video, a photo or a gallery, where we can tell.
  • url (query, string)required
GET/v1/jobs/thumbnailjobs:read
Preview picture of a link. A preview picture address for a video link, where the platform offers one.
  • url (query, string)required
GET/v1/jobs/typical-durationjobs:read
Typical time per kind of job. How long each kind of job usually takes, in seconds.
GET/v1/jobs/{job_id}jobs:read
Get a post. One post: status, the error if it failed, and result_url when it is done.
  • job_id (path, number)required
GET/v1/jobs/{job_id}/streamjobs:read
Live progress of a post. Server-sent events while a post runs. Polling GET /jobs/{job_id} or a webhook is simpler.
  • job_id (path, number)required
  • last_event_id (query, string or empty)
POST/v1/jobs/jobs:write
Make a post. Turn a link (or your own uploaded media) into a post with one of your templates. Send an Idempotency-Key. Costs credits.
  • url (string or empty)
  • template_id (number)required
  • element_overrides (list of object or empty)
  • apply_crop (true/false or empty)
  • picture_urls (list of string or empty)
  • video_urls (list of string or empty)
  • manual_tweet_text (string or empty)
  • image_source_mode (string or empty)
  • lane (interactive | bulk or empty)
POST/v1/jobs/batchjobs:write
Make many posts. Up to 50 links into one Post Rebrand template in one call. Each post costs credits.
  • template_id (number)required
  • items (list of any)required
  • image_source_mode (string or empty)
POST/v1/jobs/cropjobs:write
Crop a video. Download a video and crop it to 9:16.
  • url (string)required
  • apply_crop (true/false or empty)
POST/v1/jobs/downloadjobs:write
Download a source. Download the media of a link, unchanged.
  • url (string)required
POST/v1/jobs/fanoutjobs:write
One link, several templates. Make one post per template from the same link. Each post costs credits.
  • url (string or empty)
  • template_ids (list of number)required
  • element_overrides (list of object or empty)
  • apply_crop (true/false or empty)
  • picture_urls (list of string or empty)
  • video_urls (list of string or empty)
  • manual_tweet_text (string or empty)
  • image_source_mode (string or empty)
POST/v1/jobs/{job_id}/canceljobs:write
Cancel a post. Stop a post that is still waiting or running. Its credits come back.
  • job_id (path, number)required
POST/v1/jobs/{job_id}/get-anywayjobs:write
Get a refused cover anyway. Make a cover our check refused, when the post says it is available. Costs credits.
  • job_id (path, number)required
POST/v1/jobs/{job_id}/retryjobs:write
Retry a failed post. Make a failed post again. Costs credits like a new post.
  • job_id (path, number)required

Uploads

GET/v1/uploads/{filename}jobs:read
Get an upload. A file you uploaded.
  • filename (path, string)required
POST/v1/uploads/jobs:write
Upload a picture or video. Send your own media. Use the address it returns in picture_urls or video_urls when you make a post.

Library

GET/v1/workspace/outputsjobs:read
Your library. Every finished post, newest first, with a download_url for each.
  • page (query, number)
  • page_size (query, number)
  • template_id (query, number or empty)
  • source (query, string)
  • days (query, number or empty)

Templates

GET/v1/templates/templates:read
List templates. Your templates. Use an id from here when you make a post.
GET/v1/templates/folderstemplates:read
Template folders. Your template folders.
GET/v1/templates/post-rebrand/settingstemplates:read
Post Rebrand settings. The choices a Post Rebrand template offers.
GET/v1/templates/{template_id}templates:read
Get a template. One of your templates with all its settings.
  • template_id (path, number)required
GET/v1/templates/{template_id}/thumbnailtemplates:read
Template preview picture. A preview picture of a template.
  • template_id (path, number)required
  • w (query, number): Output width in px (clamped to 64-640)
POST/v1/templates/templates:write
Create a template. Make a template. Templates are easiest to build on the website; copy one there and adjust it.
  • name (string)required
  • template_type (twitter | snapchat | simple_overlay | canvas | tweet_rebrand | post_rebrand)required
  • bg_color (black | white)
  • bg_color_hex (string or empty)
  • profile_pic_file_id (string or empty)
  • profile_pic_mode (string or empty)
  • news_font_id (number or empty)
  • news_font_family (string or empty)
  • snap_bar_offset_y (number or empty)
  • snap_bar_padding_y (number or empty)
  • snap_bar_opacity (number or empty)
  • snap_max_lines (number or empty)
  • simple_overlay_max_lines (number or empty)
  • ai_use_frames (true/false)
  • profile_safe_layout (true/false or empty)
  • pinned_at (string or empty)
  • folder_id (number or empty)
  • last_used_at (string or empty)
  • usage_count (number or empty)
  • name_offset_x (number or empty)
  • name_offset_y (number or empty)
  • display_name_scale (number or empty)
  • handle_scale (number or empty)
  • profile_pic_offset_x (number or empty)
  • profile_pic_offset_y (number or empty)
  • profile_pic_scale (number or empty)
  • display_name (string or empty)
  • handle (string or empty)
  • tweet_prompt_text (string or empty)
  • ig_caption_prompt_text (string or empty)
  • caption_extras (string or empty)
  • ig_caption_enabled (true/false)
  • caption_use_source (true/false)
  • caption_rewrite_source (true/false)
  • content_style (meme | hype | deadpan | wholesome | dramatic | informative)
  • ai_language (en | de | es | pt | fr | it | nl | tr | ar | ja | ko | hi | id | pl | ru | match or empty)
  • ai_example_lines (string or empty)
  • ai_emoji_level (none | some | lots or empty)
  • ai_lowercase (true/false)
  • ai_banned_words (string or empty)
  • ai_end_question (true/false)
  • ig_hashtag_count (number or empty)
  • ig_hashtags_custom (string or empty)
  • tweet_text_mode (ai | fixed | manual | none)
  • tweet_text_fixed (string or empty)
  • tweet_verified (true/false or empty)
  • tweet_rebrand_mode (string or empty)
  • post_look (classic | bold | story | panel | mag | html or empty)
  • slide_text_style (native | box | bar or empty)
  • slide_pic_style (keep | blur | frame | strip or empty)
  • end_slide_when (always | replace | never or empty)
  • end_slide_style (dark | block | blur | profile | save | split | bigfollow | next or empty)
  • slide_num_style (plain | big or empty)
  • slide_frame_bg (black | blur or empty)
  • other_slides (restyle | as_they_came | leave_out or empty)
  • end_slide_line (string or empty)
  • posted_button_enabled (true/false)
  • workspace_topic_opt_in (true/false or empty)
  • workspace_topic_scope (string or empty)
  • canvas_elements (list of object or empty)
  • canvas_width (number or empty)
  • canvas_height (number or empty)
  • canvas_bg_color (string or empty)
POST/v1/templates/bulktemplates:write
Move or delete templates. Move several templates to a folder, or delete them.
  • template_ids (list of number)required
  • action (move | delete)required
  • folder_id (number or empty)
POST/v1/templates/folderstemplates:write
Create a folder. Make a template folder.
  • name (string)required
DELETE/v1/templates/folders/{folder_id}templates:write
Delete a folder. Delete a template folder. Its templates stay.
  • folder_id (path, number)required
PATCH/v1/templates/folders/{folder_id}templates:write
Rename a folder. Change a template folder.
  • folder_id (path, number)required
  • name (string)required
DELETE/v1/templates/{template_id}templates:write
Delete a template. Delete one of your templates.
  • template_id (path, number)required
PATCH/v1/templates/{template_id}templates:write
Change a template. Change a template's settings.
  • template_id (path, number)required
  • if_canvas_rev (string or empty)
  • name (string or empty)
  • template_type (twitter | snapchat | simple_overlay | canvas | tweet_rebrand | post_rebrand or empty)
  • bg_color (black | white or empty)
  • bg_color_hex (string or empty)
  • profile_pic_file_id (string or empty)
  • profile_pic_mode (string or empty)
  • news_font_id (number or empty)
  • news_font_family (string or empty)
  • snap_bar_offset_y (number or empty)
  • snap_bar_padding_y (number or empty)
  • snap_bar_opacity (number or empty)
  • snap_max_lines (number or empty)
  • simple_overlay_max_lines (number or empty)
  • ai_use_frames (true/false or empty)
  • profile_safe_layout (true/false or empty)
  • pinned_at (string or empty)
  • folder_id (number or empty)
  • last_used_at (string or empty)
  • usage_count (number or empty)
  • name_offset_x (number or empty)
  • name_offset_y (number or empty)
  • display_name_scale (number or empty)
  • handle_scale (number or empty)
  • profile_pic_offset_x (number or empty)
  • profile_pic_offset_y (number or empty)
  • profile_pic_scale (number or empty)
  • display_name (string or empty)
  • handle (string or empty)
  • tweet_prompt_text (string or empty)
  • ig_caption_prompt_text (string or empty)
  • caption_extras (string or empty)
  • ig_caption_enabled (true/false or empty)
  • caption_use_source (true/false or empty)
  • caption_rewrite_source (true/false or empty)
  • content_style (meme | hype | deadpan | wholesome | dramatic | informative or empty)
  • ai_language (en | de | es | pt | fr | it | nl | tr | ar | ja | ko | hi | id | pl | ru | match or empty)
  • ai_example_lines (string or empty)
  • ai_emoji_level (none | some | lots or empty)
  • ai_lowercase (true/false or empty)
  • ai_banned_words (string or empty)
  • ai_end_question (true/false or empty)
  • ig_hashtag_count (number or empty)
  • ig_hashtags_custom (string or empty)
  • tweet_text_mode (ai | fixed | manual | none or empty)
  • tweet_text_fixed (string or empty)
  • tweet_verified (true/false or empty)
  • tweet_rebrand_mode (string or empty)
  • post_look (classic | bold | story | panel | mag | html or empty)
  • slide_text_style (native | box | bar or empty)
  • slide_pic_style (keep | blur | frame | strip or empty)
  • end_slide_when (always | replace | never or empty)
  • end_slide_style (dark | block | blur | profile | save | split | bigfollow | next or empty)
  • slide_num_style (plain | big or empty)
  • slide_frame_bg (black | blur or empty)
  • other_slides (restyle | as_they_came | leave_out or empty)
  • end_slide_line (string or empty)
  • posted_button_enabled (true/false or empty)
  • workspace_topic_opt_in (true/false or empty)
  • workspace_topic_scope (string or empty)
  • hidden_in_workspace (true/false or empty)
  • destination_id (number or empty)
  • canvas_elements (list of object or empty)
  • canvas_width (number or empty)
  • canvas_height (number or empty)
  • canvas_bg_color (string or empty)
POST/v1/templates/{template_id}/duplicatetemplates:write
Copy a template. Make a copy of one of your templates.
  • template_id (path, number)required
POST/v1/templates/{template_id}/pintemplates:write
Pin a template. Pin or unpin a template in your list.
  • template_id (path, number)required