{ "openapi": "3.0.1", "info": { "title": "Postoria Public API", "version": "v1" }, "servers": [ { "url": "http://api.postoria.io/" } ], "paths": { "/v1/workspaces": { "get": { "tags": [ "PublicApiV1Routes" ], "operationId": "GetWorkspaces", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfWorkspaceResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/workspaces/{workspace_id}/social-accounts": { "get": { "tags": [ "PublicApiV1Routes" ], "operationId": "GetWorkspaceSocialAccounts", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfSocialAccountResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/workspaces/{workspace_id}/queues": { "get": { "tags": [ "PublicApiV1Routes" ], "operationId": "GetWorkspaceQueues", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfQueueResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/workspaces/{workspace_id}/media/uploads": { "post": { "tags": [ "PublicApiV1Routes" ], "operationId": "CreateMediaUpload", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMediaUploadRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaUploadResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/workspaces/{workspace_id}/media/{media_id}/complete": { "post": { "tags": [ "PublicApiV1Routes" ], "operationId": "CompleteMediaUpload", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "media_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/workspaces/{workspace_id}/media/imports": { "post": { "tags": [ "PublicApiV1Routes" ], "operationId": "ImportMedia", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMediaRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/workspaces/{workspace_id}/media/{media_id}": { "get": { "tags": [ "PublicApiV1Routes" ], "operationId": "GetMedia", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "media_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/workspaces/{workspace_id}/posts": { "post": { "tags": [ "PublicApiV1Routes" ], "operationId": "CreatePost", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePostRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/workspaces/{workspace_id}/posts/{post_id}": { "get": { "tags": [ "PublicApiV1Routes" ], "operationId": "GetPost", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "PublicApiV1Routes" ], "operationId": "DeletePost", "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "schemas": { "CreateMediaUploadRequest": { "type": "object", "properties": { "name": { "type": "string" }, "content_type": { "type": "string" } } }, "CreatePostRequest": { "type": "object", "properties": { "publish_mode": { "$ref": "#/components/schemas/PublishMode" }, "social_account_ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "content_type": { "$ref": "#/components/schemas/NullableContent" }, "media_ids": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "caption": { "type": "string", "nullable": true }, "link_url": { "type": "string", "nullable": true }, "first_comment": { "type": "string", "nullable": true }, "scheduled_time": { "$ref": "#/components/schemas/NullableInstant" }, "queue_id": { "type": "integer", "format": "int32", "nullable": true }, "repost": { "$ref": "#/components/schemas/RepostSettings" }, "you_tube": { "$ref": "#/components/schemas/YouTubeOptions" }, "tik_tok": { "$ref": "#/components/schemas/TikTokOptions" } } }, "Error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "param": { "type": "string", "nullable": true }, "details": { }, "request_id": { "type": "string" } } }, "ErrorResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/Error" } } }, "ImportMediaRequest": { "type": "object", "properties": { "url": { "type": "string" } } }, "ListResponseOfQueueResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QueueResponse" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } }, "ListResponseOfSocialAccountResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SocialAccountResponse" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } }, "ListResponseOfWorkspaceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceResponse" } }, "pagination": { "$ref": "#/components/schemas/Pagination" } } }, "MediaResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/MediaStatus" }, "file_id": { "type": "integer", "format": "int32", "nullable": true }, "error_code": { "type": "string", "nullable": true }, "error_message": { "type": "string", "nullable": true } } }, "MediaStatus": { "enum": [ "waiting_for_upload", "processing", "ready", "failed" ] }, "MediaUpload": { "type": "object", "properties": { "url": { "type": "string" } } }, "MediaUploadResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/MediaStatus" }, "upload": { "$ref": "#/components/schemas/MediaUpload" } } }, "Network": { "enum": [ "facebook", "instagram", "linked_in", "google_business_profile", "threads", "x", "pinterest", "you_tube", "tik_tok", "telegram", "bluesky", "reddit", "tumblr" ] }, "NullableContent": { "enum": [ "image", "video", "story", "link", "carousel", "text", "reel", null ], "nullable": true }, "NullableInstant": { "nullable": true }, "NullablePostRepeatFrequency": { "enum": [ "do_not_repeat", "every1_day", "every2_day", "every3_day", "every4_day", "every5_day", "every6_day", "every7_day", "every8_day", "every9_day", "every10_day", "every11_day", "every12_day", "every13_day", "every14_day", "every15_day", "every16_day", "every17_day", "every18_day", "every19_day", "every20_day", "every21_day", "every22_day", "every23_day", "every24_day", "every25_day", "every26_day", "every27_day", "every28_day", "every29_day", "every30_day", "every31_day", "every32_day", "every33_day", "every34_day", "every35_day", "every36_day", "every37_day", "every38_day", "every39_day", "every40_day", "every41_day", "every42_day", "every43_day", "every44_day", "every45_day", "every46_day", "every47_day", "every48_day", "every49_day", "every50_day", "every51_day", "every52_day", "every53_day", "every54_day", "every55_day", "every56_day", "every57_day", "every58_day", "every59_day", "every60_day", "every1_month", "every2_month", "every3_month", "every4_month", "every6_month", "every1_year", null ], "nullable": true }, "NullableTikTokWhoCanWatch": { "enum": [ "public", "followers", "friends", "private", null ], "nullable": true }, "NullableYouTubeVisibility": { "enum": [ "private", "unlisted", "public", null ], "nullable": true }, "Pagination": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "type": "string", "nullable": true } } }, "PostAccountResult": { "type": "object", "properties": { "account_id": { "type": "integer", "format": "int32" }, "link_to_post": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true } } }, "PostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/PostStatus" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PostAccountResult" } } } }, "PostStatus": { "enum": [ "draft", "scheduled", "in_progress", "posted", "queued" ] }, "PublishMode": { "enum": [ "publish_now", "schedule", "queue" ] }, "QueueResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "is_paused": { "type": "boolean" } } }, "RepostSettings": { "type": "object", "properties": { "frequency": { "$ref": "#/components/schemas/NullablePostRepeatFrequency" }, "until": { "$ref": "#/components/schemas/NullableInstant" } }, "nullable": true }, "SocialAccountResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "network": { "$ref": "#/components/schemas/Network" }, "url": { "type": "string" } } }, "TikTokOptions": { "type": "object", "properties": { "who_can_watch": { "$ref": "#/components/schemas/NullableTikTokWhoCanWatch" }, "allow_comments": { "type": "boolean", "nullable": true }, "allow_duet": { "type": "boolean", "nullable": true }, "allow_stitch": { "type": "boolean", "nullable": true }, "disclose_post_content": { "type": "boolean", "nullable": true }, "your_brand": { "type": "boolean", "nullable": true }, "branded_content": { "type": "boolean", "nullable": true } }, "nullable": true }, "WorkspaceResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "timezone": { "type": "string" } } }, "YouTubeOptions": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "visibility": { "$ref": "#/components/schemas/NullableYouTubeVisibility" }, "category": { "type": "string", "nullable": true }, "made_for_kids": { "type": "boolean", "nullable": true }, "video_language": { "type": "string", "nullable": true }, "recording_date": { "$ref": "#/components/schemas/NullableInstant" }, "tags": { "type": "array", "items": { "type": "string" } } }, "nullable": true } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Authorization: Bearer ", "scheme": "bearer", "bearerFormat": "API Key" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "PublicApiV1Routes" } ] }