{ "openapi": "3.1.0", "info": { "title": "Delulu API", "version": "1.0.0", "description": "Typed API contract shared by every backend consumer." }, "paths": { "/health": { "get": { "tags": [ "health" ], "operationId": "health.check", "parameters": [], "security": [], "responses": { "200": { "description": "Service health and the time at which it was checked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } }, "503": { "description": "HealthUnavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthUnavailable" } } } } }, "description": "Reports whether the API process is ready to receive requests.", "summary": "Check service health" } }, "/v1/me": { "get": { "tags": [ "me" ], "operationId": "me.current", "parameters": [], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "MeResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeResponse" } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "summary": "Get the authenticated user" } }, "/v1/me/overview/{workspaceId}": { "get": { "tags": [ "me" ], "operationId": "me.overview", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "WorkspaceOverviewResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceOverviewResponse" } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "summary": "Get the workspace command-center overview" } }, "/v1/me/setup/{workspaceId}": { "get": { "tags": [ "me" ], "operationId": "me.setup", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string" }, "connectedPlatforms": { "type": "array", "items": { "type": "string" } }, "subscription": { "type": "object", "properties": { "plan": { "type": "string" }, "status": { "type": "string" }, "paid": { "type": "boolean" } }, "required": [ "plan", "status", "paid" ], "additionalProperties": false }, "optionalSteps": { "type": "object", "additionalProperties": { "type": "string" } }, "outstandingAction": { "anyOf": [ { "type": "string", "enum": [ "connect_account", "complete_payment" ] }, { "type": "null" } ] }, "onboardingComplete": { "type": "boolean" } }, "required": [ "workspaceId", "connectedPlatforms", "subscription", "optionalSteps", "outstandingAction", "onboardingComplete" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "patch": { "tags": [ "me" ], "operationId": "me.updateSetup", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "boolean" } }, "required": [ "updated" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "optionalSteps": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "completed", "skipped" ] } } }, "required": [ "optionalSteps" ], "additionalProperties": false } } }, "required": true } } }, "/v1/me/email-preferences": { "get": { "tags": [ "me" ], "operationId": "me.emailPreferences", "parameters": [], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "productLifecycleEnabled": { "type": "boolean" }, "marketingEnabled": { "type": "boolean" } }, "required": [ "productLifecycleEnabled", "marketingEnabled" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "put": { "tags": [ "me" ], "operationId": "me.updateEmailPreferences", "parameters": [], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "productLifecycleEnabled": { "type": "boolean" }, "marketingEnabled": { "type": "boolean" } }, "required": [ "productLifecycleEnabled", "marketingEnabled" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productLifecycleEnabled": { "type": "boolean" }, "marketingEnabled": { "type": "boolean" } }, "required": [ "productLifecycleEnabled", "marketingEnabled" ], "additionalProperties": false } } }, "required": true } } }, "/v1/me/workspaces": { "get": { "tags": [ "me" ], "operationId": "me.workspaces", "parameters": [], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "MeWorkspacesResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeWorkspacesResponse" } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "summary": "List the user's workspace memberships" } }, "/v1/workspaces/{workspaceId}/posts": { "get": { "tags": [ "Posts" ], "operationId": "posts.list", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "status", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "pending_review", "changes_requested", "scheduled", "publishing", "published", "partially_failed", "failed" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "app", "api", "automation" ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "status", "groups", "targets", "source", "externalSubmissionId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "post": { "tags": [ "Posts" ], "operationId": "posts.create", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "pending_review", "changes_requested", "scheduled", "publishing", "published", "partially_failed", "failed" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "app", "api", "automation" ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "status", "groups", "targets", "source", "externalSubmissionId", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "connectionId", "groupId", "settings", "scheduledAt" ], "additionalProperties": false } }, "intent": { "anyOf": [ { "type": "string", "enum": [ "draft", "schedule", "publish_now" ] }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "app", "api", "automation" ] }, { "type": "null" } ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "submitForReview": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "groups", "targets" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/posts/{id}/publish": { "post": { "tags": [ "Posts" ], "operationId": "posts.publishNow", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "pending_review", "changes_requested", "scheduled", "publishing", "published", "partially_failed", "failed" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "app", "api", "automation" ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "status", "groups", "targets", "source", "externalSubmissionId", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/posts/bulk": { "post": { "tags": [ "Posts" ], "operationId": "posts.bulkCreate", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "index": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "ok": { "type": "boolean", "enum": [ true ] }, "post": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "pending_review", "changes_requested", "scheduled", "publishing", "published", "partially_failed", "failed" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "app", "api", "automation" ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "status", "groups", "targets", "source", "externalSubmissionId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "index", "ok", "post" ], "additionalProperties": false }, { "type": "object", "properties": { "index": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "ok": { "type": "boolean", "enum": [ false ] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "index", "ok", "error" ], "additionalProperties": false } ] } } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "connectionId", "groupId", "settings", "scheduledAt" ], "additionalProperties": false } }, "intent": { "anyOf": [ { "type": "string", "enum": [ "draft", "schedule", "publish_now" ] }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "app", "api", "automation" ] }, { "type": "null" } ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "submitForReview": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "groups", "targets" ], "additionalProperties": false } } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/posts/{id}": { "get": { "tags": [ "Posts" ], "operationId": "posts.get", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "pending_review", "changes_requested", "scheduled", "publishing", "published", "partially_failed", "failed" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "app", "api", "automation" ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "status", "groups", "targets", "source", "externalSubmissionId", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "patch": { "tags": [ "Posts" ], "operationId": "posts.update", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "pending_review", "changes_requested", "scheduled", "publishing", "published", "partially_failed", "failed" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "app", "api", "automation" ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "status", "groups", "targets", "source", "externalSubmissionId", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "isDefault": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "media": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailMediaId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnailTimestamp": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "id" ], "additionalProperties": false } }, "delayMinutes": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] } }, "required": [ "text", "media" ], "additionalProperties": false } } }, "required": [ "id", "isDefault", "segments" ], "additionalProperties": false } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "connectionId", "groupId", "settings", "scheduledAt" ], "additionalProperties": false } }, "intent": { "anyOf": [ { "type": "string", "enum": [ "draft", "schedule", "publish_now" ] }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "app", "api", "automation" ] }, { "type": "null" } ] }, "externalSubmissionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "submitForReview": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "groups", "targets" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Posts" ], "operationId": "posts.remove", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/posts/{id}/targets": { "get": { "tags": [ "Posts" ], "operationId": "posts.targets", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/posts/{id}/targets/{targetId}": { "patch": { "tags": [ "Posts" ], "operationId": "posts.updateTarget", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "targetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "settings": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "scheduledAt": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/posts/{id}/targets/{targetId}/retry": { "post": { "tags": [ "Posts" ], "operationId": "posts.retryTarget", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "targetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "groupId": { "type": "string" }, "settings": { "anyOf": [ { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "BLUESKY" ] }, "values": { "type": "object", "properties": { "replyDisabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FACEBOOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "FRIENDS", "ONLY_ME" ] } }, "required": [ "privacy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "FARCASTER" ] }, "values": { "type": "object", "properties": { "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "INSTAGRAM" ] }, "values": { "type": "object", "properties": { "shareToFeed": { "type": "boolean" }, "shareToStory": { "type": "boolean" }, "trialReels": { "type": "boolean" }, "graduationStrategy": { "type": "string", "enum": [ "MANUAL", "SS_PERFORMANCE" ] } }, "required": [ "shareToFeed", "shareToStory", "trialReels", "graduationStrategy" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "LINKEDIN" ] }, "values": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "PUBLIC", "CONNECTIONS" ] } }, "required": [ "visibility" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "PINTEREST" ] }, "values": { "type": "object", "properties": { "boardId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "THREADS" ] }, "values": { "type": "object", "properties": { "replyControl": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyControl" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TIKTOK" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "FOLLOWER_OF_CREATOR", "SELF_ONLY" ] }, "allowComments": { "type": "boolean" }, "allowDuet": { "type": "boolean" }, "allowStitch": { "type": "boolean" }, "promotionContent": { "type": "string", "enum": [ "NONE", "SELF", "PAID", "BOTH" ] } }, "required": [ "privacy", "allowComments", "allowDuet", "allowStitch", "promotionContent" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "TWITTER" ] }, "values": { "type": "object", "properties": { "replyRestriction": { "type": "string", "enum": [ "everyone", "following", "mentioned" ] } }, "required": [ "replyRestriction" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false }, { "type": "object", "properties": { "platform": { "type": "string", "enum": [ "YOUTUBE" ] }, "values": { "type": "object", "properties": { "privacy": { "type": "string", "enum": [ "PUBLIC", "PRIVATE", "UNLISTED" ] }, "madeForKids": { "type": "boolean" }, "ageRestriction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "privacy", "madeForKids" ], "additionalProperties": false } }, "required": [ "platform", "values" ], "additionalProperties": false } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "publishing", "published", "failed" ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attempts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "connectionId", "groupId", "settings", "scheduledAt", "status", "platformPostId", "platformPostUrl", "postedAt", "error", "attempts" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/reviews": { "get": { "tags": [ "Reviews" ], "operationId": "reviews.queue", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "postId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected" ] }, "contentFingerprint": { "type": "string" }, "submittedByMemberId": { "type": "string" }, "resolvedByMemberId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "postId", "status", "contentFingerprint", "submittedByMemberId", "resolvedByMemberId", "resolvedAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/reviews/posts/{postId}": { "get": { "tags": [ "Reviews" ], "operationId": "reviews.getForPost", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "postId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected" ] }, "contentFingerprint": { "type": "string" }, "submittedByMemberId": { "type": "string" }, "resolvedByMemberId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "postId", "status", "contentFingerprint", "submittedByMemberId", "resolvedByMemberId", "resolvedAt" ], "additionalProperties": false }, { "type": "null" } ] } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "post": { "tags": [ "Reviews" ], "operationId": "reviews.act", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "postId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected" ] }, "contentFingerprint": { "type": "string" }, "submittedByMemberId": { "type": "string" }, "resolvedByMemberId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "resolvedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "postId", "status", "contentFingerprint", "submittedByMemberId", "resolvedByMemberId", "resolvedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "submit" ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "action" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "approve" ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "missedSlot": { "anyOf": [ { "type": "string", "enum": [ "publish_now", "reschedule" ] }, { "type": "null" } ] }, "scheduledAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "action" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "reject" ] }, "reason": { "type": "string" } }, "required": [ "action", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "withdraw" ] } }, "required": [ "action" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "comment" ] }, "comment": { "type": "string" } }, "required": [ "action", "comment" ], "additionalProperties": false } ] } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/reviews/posts/{postId}/activity": { "get": { "tags": [ "Reviews" ], "operationId": "reviews.activity", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "activityType": { "type": "string", "enum": [ "review.submitted", "review.approved", "review.rejected", "review.withdrawn", "review.commented", "schedule.missed" ] }, "actorMemberId": { "type": "string" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "activityType", "actorMemberId", "comment", "createdAt" ], "additionalProperties": false } } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/reviews/bulk": { "post": { "tags": [ "Reviews" ], "operationId": "reviews.bulkAct", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "postId": { "type": "string" }, "ok": { "type": "boolean" } }, "required": [ "postId", "ok" ], "additionalProperties": false } } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "postIds": { "type": "array", "items": { "type": "string" } }, "action": { "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "approve" ] } }, "required": [ "action" ], "additionalProperties": false }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "reject" ] }, "reason": { "type": "string" } }, "required": [ "action", "reason" ], "additionalProperties": false } ] } }, "required": [ "postIds", "action" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/media": { "get": { "tags": [ "Media" ], "operationId": "media.list", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "bucketKey": { "type": "string" }, "url": { "type": "string" }, "mediaType": { "type": "string", "enum": [ "image", "video", "document" ] }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizeBytes": { "type": "string" }, "width": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "height": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "thumbnails": { "type": "array", "items": { "type": "string" } }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "bucketKey", "url", "mediaType", "mimeType", "sizeBytes", "width", "height", "durationSeconds", "thumbnails", "altText", "status", "createdAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/media/{id}": { "get": { "tags": [ "Media" ], "operationId": "media.get", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "bucketKey": { "type": "string" }, "url": { "type": "string" }, "mediaType": { "type": "string", "enum": [ "image", "video", "document" ] }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizeBytes": { "type": "string" }, "width": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "height": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "thumbnails": { "type": "array", "items": { "type": "string" } }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "bucketKey", "url", "mediaType", "mimeType", "sizeBytes", "width", "height", "durationSeconds", "thumbnails", "altText", "status", "createdAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "delete": { "tags": [ "Media" ], "operationId": "media.remove", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/media/uploads": { "post": { "tags": [ "Media" ], "operationId": "media.uploads", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "mediaId": { "type": "string" }, "bucketKey": { "type": "string" }, "uploadUrl": { "type": "string" } }, "required": [ "mediaId", "bucketKey", "uploadUrl" ], "additionalProperties": false } } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "filename": { "type": "string" }, "contentType": { "type": "string" }, "width": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "height": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "thumbnails": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "filename", "contentType" ], "additionalProperties": false } } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/media/imports": { "post": { "tags": [ "Media" ], "operationId": "media.import", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "bucketKey": { "type": "string" }, "url": { "type": "string" }, "mediaType": { "type": "string", "enum": [ "image", "video", "document" ] }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizeBytes": { "type": "string" }, "width": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "height": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "thumbnails": { "type": "array", "items": { "type": "string" } }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "bucketKey", "url", "mediaType", "mimeType", "sizeBytes", "width", "height", "durationSeconds", "thumbnails", "altText", "status", "createdAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "idempotencyKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/media/complete": { "post": { "tags": [ "Media" ], "operationId": "media.complete", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "bucketKey": { "type": "string" }, "url": { "type": "string" }, "mediaType": { "type": "string", "enum": [ "image", "video", "document" ] }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizeBytes": { "type": "string" }, "width": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "height": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "thumbnails": { "type": "array", "items": { "type": "string" } }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "ready", "failed" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "bucketKey", "url", "mediaType", "mimeType", "sizeBytes", "width", "height", "durationSeconds", "thumbnails", "altText", "status", "createdAt" ], "additionalProperties": false } } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "mediaId": { "type": "string" } }, "required": [ "mediaId" ], "additionalProperties": false } } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/connections": { "get": { "tags": [ "Connections" ], "operationId": "connections.list", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "platform": { "type": "string" }, "profileId": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "platform", "profileId", "username", "displayName", "expiresAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/connections/{id}": { "delete": { "tags": [ "Connections" ], "operationId": "connections.remove", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/connections/connect/{platform}": { "post": { "tags": [ "Connections" ], "operationId": "connections.mint", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "expiresIn": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "url", "expiresIn" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "includeInsights": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "client": { "anyOf": [ { "type": "string", "enum": [ "cli", "mcp" ] }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/connections/{id}/transfer": { "post": { "tags": [ "Connections" ], "operationId": "connections.confirmTransfer", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmed": { "type": "boolean" } }, "required": [ "confirmed" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sourceWorkspaceId": { "type": "string" } }, "required": [ "sourceWorkspaceId" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}": { "get": { "tags": [ "Workspace administration" ], "operationId": "admin.workspace", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isPersonal": { "type": "boolean" }, "billingOwnerUserId": { "type": "string" } }, "required": [ "id", "name", "slug", "isPersonal", "billingOwnerUserId" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "patch": { "tags": [ "Workspace administration" ], "operationId": "admin.updateWorkspace", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isPersonal": { "type": "boolean" }, "billingOwnerUserId": { "type": "string" } }, "required": [ "id", "name", "slug", "isPersonal", "billingOwnerUserId" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Workspace administration" ], "operationId": "admin.deleteWorkspace", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/members": { "get": { "tags": [ "Workspace administration" ], "operationId": "admin.members", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] } }, "required": [ "id", "userId", "email", "name", "role" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "post": { "tags": [ "Workspace administration" ], "operationId": "admin.inviteMember", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitationId": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] } }, "required": [ "invitationId", "email", "role" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] } }, "required": [ "email", "role" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/members/{id}": { "patch": { "tags": [ "Workspace administration" ], "operationId": "admin.updateMember", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] } }, "required": [ "id", "userId", "email", "name", "role" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] } }, "required": [ "role" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Workspace administration" ], "operationId": "admin.removeMember", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/api-keys": { "get": { "tags": [ "Workspace administration" ], "operationId": "admin.apiKeys", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "keyPrefix": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "posts:read", "posts:write", "accounts:read", "accounts:write", "stats:read", "billing:write", "media:write", "reviews:read", "reviews:write", "members:read", "members:write", "apikeys:write" ] } }, "lastUsedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "keyPrefix", "role", "scopes", "lastUsedAt", "expiresAt", "revokedAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "post": { "tags": [ "Workspace administration" ], "operationId": "admin.createApiKey", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "keyPrefix": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "posts:read", "posts:write", "accounts:read", "accounts:write", "stats:read", "billing:write", "media:write", "reviews:read", "reviews:write", "members:read", "members:write", "apikeys:write" ] } }, "lastUsedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "keyPrefix", "role", "scopes", "lastUsedAt", "expiresAt", "revokedAt" ], "additionalProperties": false }, "token": { "type": "string" } }, "required": [ "key", "token" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "posts:read", "posts:write", "accounts:read", "accounts:write", "stats:read", "billing:write", "media:write", "reviews:read", "reviews:write", "members:read", "members:write", "apikeys:write" ] } }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "role", "scopes" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/api-keys/{id}": { "delete": { "tags": [ "Workspace administration" ], "operationId": "admin.revokeApiKey", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/analytics/operational": { "get": { "tags": [ "Analytics" ], "operationId": "analytics.operational", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string" }, "statsVersion": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "counts": { "type": "object", "properties": { "totalPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "drafts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "pendingReview": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduled": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "publishing": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "published": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "partiallyFailed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "failed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduledNextSevenDays": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "publishedLastThirtyDays": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "totalPosts", "drafts", "pendingReview", "scheduled", "publishing", "published", "partiallyFailed", "failed", "scheduledNextSevenDays", "publishedLastThirtyDays" ], "additionalProperties": false }, "streak": { "type": "object", "properties": { "currentDays": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "longestDays": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "lastPublishedDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "currentDays", "longestDays", "lastPublishedDate" ], "additionalProperties": false }, "generatedAt": { "type": "string" } }, "required": [ "workspaceId", "statsVersion", "counts", "streak", "generatedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } }, "503": { "description": "AnalyticsProviderError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsProviderError" } } } } }, "summary": "Get exact workspace operational counts" } }, "/v1/workspaces/{workspaceId}/analytics/connections/{connectionId}/insights": { "get": { "tags": [ "Analytics" ], "operationId": "analytics.insights", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "connectionId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "windowDays", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "current": { "type": "object", "properties": { "since": { "type": "string" }, "until": { "type": "string" }, "totals": { "type": "object", "properties": { "impressions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "reach": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "engagements": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "followersGained": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "profileViews": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "impressions", "reach", "engagements", "followersGained", "profileViews" ], "additionalProperties": false }, "points": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "impressions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "reach": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "engagements": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "followersGained": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "profileViews": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "date", "impressions", "reach", "engagements", "followersGained", "profileViews" ], "additionalProperties": false } } }, "required": [ "since", "until", "totals", "points" ], "additionalProperties": false }, "previous": { "type": "object", "properties": { "since": { "type": "string" }, "until": { "type": "string" }, "totals": { "type": "object", "properties": { "impressions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "reach": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "engagements": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "followersGained": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "profileViews": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "impressions", "reach", "engagements", "followersGained", "profileViews" ], "additionalProperties": false }, "points": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "impressions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "reach": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "engagements": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "followersGained": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "profileViews": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "date", "impressions", "reach", "engagements", "followersGained", "profileViews" ], "additionalProperties": false } } }, "required": [ "since", "until", "totals", "points" ], "additionalProperties": false }, "percentageChange": { "type": "object", "properties": { "impressions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "reach": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "engagements": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "followersGained": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "profileViews": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "impressions", "reach", "engagements", "followersGained", "profileViews" ], "additionalProperties": false }, "topPosts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaType": { "type": "string" }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publishedAt": { "type": "string" }, "impressions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "reach": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "engagements": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "caption", "mediaType", "permalink", "publishedAt", "impressions", "reach", "engagements" ], "additionalProperties": false } }, "stale": { "type": "boolean" }, "cachedAt": { "type": "string" } }, "required": [ "current", "previous", "percentageChange", "topPosts", "stale", "cachedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } }, "503": { "description": "AnalyticsProviderError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsProviderError" } } } } }, "summary": "Get live platform insights with comparison" } }, "/v1/workspaces/{workspaceId}/automations/{platform}/{category}": { "get": { "tags": [ "Automations" ], "operationId": "automations.list", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string", "enum": [ "instagram" ] }, "required": true }, { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "connectionId": { "type": "string" }, "platform": { "type": "string" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "trigger" ] }, "triggerType": { "type": "string", "enum": [ "comment", "mention", "story_reply" ] }, "targetPostIds": { "type": "array", "items": { "type": "string" } }, "pendingPostIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "allOf": [ { "pattern": "^post_[useandom\\-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict]{12}$" } ] } }, { "type": "null" } ] }, "keywordFilter": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "operator" ], "additionalProperties": false }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "triggerType", "targetPostIds" ], "additionalProperties": false } }, "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "condition" ] }, "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "yesStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "noStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "operator" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "send_dm" ] }, "messageTemplate": { "type": "string" }, "buttons": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "quick_reply" ] }, "title": { "type": "string" }, "payload": { "type": "string" }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "title", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "title", "url" ], "additionalProperties": false } ] } }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "messageTemplate" ], "additionalProperties": false } ] } }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "position": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "required": [ "id", "content", "position" ], "additionalProperties": false } }, "nodePositions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "totalTriggered": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalDmsSent": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalFailed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "connectionId", "platform", "category", "name", "description", "enabled", "triggers", "steps", "notes", "nodePositions", "totalTriggered", "totalDmsSent", "totalFailed", "createdAt", "updatedAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "post": { "tags": [ "Automations" ], "operationId": "automations.create", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string", "enum": [ "instagram" ] }, "required": true }, { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "connectionId": { "type": "string" }, "platform": { "type": "string" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "trigger" ] }, "triggerType": { "type": "string", "enum": [ "comment", "mention", "story_reply" ] }, "targetPostIds": { "type": "array", "items": { "type": "string" } }, "pendingPostIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "allOf": [ { "pattern": "^post_[useandom\\-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict]{12}$" } ] } }, { "type": "null" } ] }, "keywordFilter": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "operator" ], "additionalProperties": false }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "triggerType", "targetPostIds" ], "additionalProperties": false } }, "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "condition" ] }, "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "yesStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "noStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "operator" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "send_dm" ] }, "messageTemplate": { "type": "string" }, "buttons": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "quick_reply" ] }, "title": { "type": "string" }, "payload": { "type": "string" }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "title", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "title", "url" ], "additionalProperties": false } ] } }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "messageTemplate" ], "additionalProperties": false } ] } }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "position": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "required": [ "id", "content", "position" ], "additionalProperties": false } }, "nodePositions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "totalTriggered": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalDmsSent": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalFailed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "connectionId", "platform", "category", "name", "description", "enabled", "triggers", "steps", "notes", "nodePositions", "totalTriggered", "totalDmsSent", "totalFailed", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string", "allOf": [ { "pattern": "^connection_[useandom\\-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict]{12}$" } ] }, "name": { "type": "string" }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "trigger" ] }, "triggerType": { "type": "string", "enum": [ "comment", "mention", "story_reply" ] }, "targetPostIds": { "type": "array", "items": { "type": "string" } }, "pendingPostIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "allOf": [ { "pattern": "^post_[useandom\\-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict]{12}$" } ] } }, { "type": "null" } ] }, "keywordFilter": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "operator" ], "additionalProperties": false }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "triggerType", "targetPostIds" ], "additionalProperties": false } }, "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "condition" ] }, "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "yesStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "noStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "operator" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "send_dm" ] }, "messageTemplate": { "type": "string" }, "buttons": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "quick_reply" ] }, "title": { "type": "string" }, "payload": { "type": "string" }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "title", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "title", "url" ], "additionalProperties": false } ] } }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "messageTemplate" ], "additionalProperties": false } ] } }, "notes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "position": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "required": [ "id", "content", "position" ], "additionalProperties": false } }, { "type": "null" } ] }, "nodePositions": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "connectionId", "name", "triggers", "steps" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/automations/{platform}/{category}/{id}": { "get": { "tags": [ "Automations" ], "operationId": "automations.get", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string", "enum": [ "instagram" ] }, "required": true }, { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "connectionId": { "type": "string" }, "platform": { "type": "string" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "trigger" ] }, "triggerType": { "type": "string", "enum": [ "comment", "mention", "story_reply" ] }, "targetPostIds": { "type": "array", "items": { "type": "string" } }, "pendingPostIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "allOf": [ { "pattern": "^post_[useandom\\-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict]{12}$" } ] } }, { "type": "null" } ] }, "keywordFilter": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "operator" ], "additionalProperties": false }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "triggerType", "targetPostIds" ], "additionalProperties": false } }, "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "condition" ] }, "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "yesStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "noStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "operator" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "send_dm" ] }, "messageTemplate": { "type": "string" }, "buttons": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "quick_reply" ] }, "title": { "type": "string" }, "payload": { "type": "string" }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "title", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "title", "url" ], "additionalProperties": false } ] } }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "messageTemplate" ], "additionalProperties": false } ] } }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "position": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "required": [ "id", "content", "position" ], "additionalProperties": false } }, "nodePositions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "totalTriggered": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalDmsSent": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalFailed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "connectionId", "platform", "category", "name", "description", "enabled", "triggers", "steps", "notes", "nodePositions", "totalTriggered", "totalDmsSent", "totalFailed", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "patch": { "tags": [ "Automations" ], "operationId": "automations.update", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string", "enum": [ "instagram" ] }, "required": true }, { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "connectionId": { "type": "string" }, "platform": { "type": "string" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "trigger" ] }, "triggerType": { "type": "string", "enum": [ "comment", "mention", "story_reply" ] }, "targetPostIds": { "type": "array", "items": { "type": "string" } }, "pendingPostIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "allOf": [ { "pattern": "^post_[useandom\\-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict]{12}$" } ] } }, { "type": "null" } ] }, "keywordFilter": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "operator" ], "additionalProperties": false }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "triggerType", "targetPostIds" ], "additionalProperties": false } }, "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "condition" ] }, "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "yesStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "noStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "operator" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "send_dm" ] }, "messageTemplate": { "type": "string" }, "buttons": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "quick_reply" ] }, "title": { "type": "string" }, "payload": { "type": "string" }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "title", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "title", "url" ], "additionalProperties": false } ] } }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "messageTemplate" ], "additionalProperties": false } ] } }, "notes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "position": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "required": [ "id", "content", "position" ], "additionalProperties": false } }, "nodePositions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "totalTriggered": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalDmsSent": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalFailed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "workspaceId", "connectionId", "platform", "category", "name", "description", "enabled", "triggers", "steps", "notes", "nodePositions", "totalTriggered", "totalDmsSent", "totalFailed", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, { "type": "null" } ] }, "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "triggers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "trigger" ] }, "triggerType": { "type": "string", "enum": [ "comment", "mention", "story_reply" ] }, "targetPostIds": { "type": "array", "items": { "type": "string" } }, "pendingPostIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "allOf": [ { "pattern": "^post_[useandom\\-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict]{12}$" } ] } }, { "type": "null" } ] }, "keywordFilter": { "anyOf": [ { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "operator" ], "additionalProperties": false }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "triggerType", "targetPostIds" ], "additionalProperties": false } }, { "type": "null" } ] }, "steps": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "condition" ] }, "operator": { "type": "string", "enum": [ "contains", "not_contains", "equals", "starts_with", "ends_with", "regex", "always", "is_follower", "has_email" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "caseSensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "yesStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "noStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "operator" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "send_dm" ] }, "messageTemplate": { "type": "string" }, "buttons": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "quick_reply" ] }, "title": { "type": "string" }, "payload": { "type": "string" }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "title", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "title", "url" ], "additionalProperties": false } ] } }, { "type": "null" } ] }, "commentReply": { "anyOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean" }, "replies": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "replies" ], "additionalProperties": false }, { "type": "null" } ] }, "nextStepId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "type", "messageTemplate" ], "additionalProperties": false } ] } }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "type": "string" }, "position": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, "required": [ "id", "content", "position" ], "additionalProperties": false } }, { "type": "null" } ] }, "nodePositions": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "x": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "y": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "x", "y" ], "additionalProperties": false } }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Automations" ], "operationId": "automations.remove", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string", "enum": [ "instagram" ] }, "required": true }, { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/automations/{platform}/{category}/runs": { "get": { "tags": [ "Automations" ], "operationId": "automations.runs", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string", "enum": [ "instagram" ] }, "required": true }, { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "automationId", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "automationId": { "type": "string" }, "status": { "type": "string" }, "input": { "type": "object" }, "output": { "type": "object" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "startedAt": { "type": "string" }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "automationId", "status", "input", "output", "error", "startedAt", "completedAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/automations/{platform}/{category}/inbox": { "get": { "tags": [ "Automations" ], "operationId": "automations.inbox", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string", "enum": [ "instagram" ] }, "required": true }, { "name": "category", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "sessionId": { "type": "string" }, "automationId": { "type": "string" }, "platformUserId": { "type": "string" }, "platformUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentStepId": { "type": "string" }, "status": { "type": "string" }, "lastActivityAt": { "type": "string" } }, "required": [ "sessionId", "automationId", "platformUserId", "platformUsername", "currentStepId", "status", "lastActivityAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/subscription": { "get": { "tags": [ "Billing" ], "operationId": "billing.subscription", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "billingOwnerUserId": { "type": "string" }, "plan": { "type": "string" }, "status": { "type": "string" }, "currentPeriodStart": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addons": { "type": "object" }, "billingInterval": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recurringAmountMinor": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "cancelAtPeriodEnd": { "type": "boolean" }, "canManageBilling": { "type": "boolean" } }, "required": [ "id", "billingOwnerUserId", "plan", "status", "currentPeriodStart", "currentPeriodEnd", "addons", "billingInterval", "currency", "recurringAmountMinor", "cancelAtPeriodEnd", "canManageBilling" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/usage": { "get": { "tags": [ "Billing" ], "operationId": "billing.usage", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "billingOwnerUserId": { "type": "string" }, "usage": { "type": "object", "properties": { "socialAccounts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "monthlyPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaStorageBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "apiRequestsPerMonth": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "dmsSent": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "dmsSkipped": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "transcriptionsUsed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "socialAccounts", "monthlyPosts", "mediaStorageBytes", "apiRequestsPerMonth", "dmsSent", "dmsSkipped", "transcriptionsUsed" ], "additionalProperties": false } }, "required": [ "billingOwnerUserId", "usage" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/transactions": { "get": { "tags": [ "Billing" ], "operationId": "billing.transactions", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "offset", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "providerTransactionId": { "type": "string" }, "amountMinor": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "currency": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "providerTransactionId", "amountMinor", "currency", "status", "createdAt" ], "additionalProperties": false } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/portal": { "post": { "tags": [ "Billing" ], "operationId": "billing.portal", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/checkout": { "post": { "tags": [ "Billing" ], "operationId": "billing.checkout", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "ECHO", "VIBE" ] }, "interval": { "type": "string", "enum": [ "MONTHLY", "YEARLY" ] }, "currency": { "type": "string", "enum": [ "USD", "INR" ] }, "returnPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "idempotencyKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "plan", "interval", "currency" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/billing/transfers": { "get": { "tags": [ "Billing" ], "operationId": "billing.transfers", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "fromUserId": { "type": "string" }, "toUserId": { "type": "string" }, "requestedByUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted", "cancelled", "expired" ] }, "expiresAt": { "type": "string" }, "acceptedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "fromUserId", "toUserId", "requestedByUserId", "status", "expiresAt", "acceptedAt", "createdAt" ], "additionalProperties": false } } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } }, "post": { "tags": [ "Billing" ], "operationId": "billing.requestTransfer", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "fromUserId": { "type": "string" }, "toUserId": { "type": "string" }, "requestedByUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted", "cancelled", "expired" ] }, "expiresAt": { "type": "string" }, "acceptedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "fromUserId", "toUserId", "requestedByUserId", "status", "expiresAt", "acceptedAt", "createdAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "toUserId": { "type": "string" } }, "required": [ "toUserId" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/billing/transfers/{id}/accept": { "post": { "tags": [ "Billing" ], "operationId": "billing.acceptTransfer", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "fromUserId": { "type": "string" }, "toUserId": { "type": "string" }, "requestedByUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted", "cancelled", "expired" ] }, "expiresAt": { "type": "string" }, "acceptedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "fromUserId", "toUserId", "requestedByUserId", "status", "expiresAt", "acceptedAt", "createdAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/transfers/{id}/cancel": { "post": { "tags": [ "Billing" ], "operationId": "billing.cancelTransfer", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "fromUserId": { "type": "string" }, "toUserId": { "type": "string" }, "requestedByUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted", "cancelled", "expired" ] }, "expiresAt": { "type": "string" }, "acceptedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" } }, "required": [ "id", "workspaceId", "fromUserId", "toUserId", "requestedByUserId", "status", "expiresAt", "acceptedAt", "createdAt" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/cancellation": { "get": { "tags": [ "Billing" ], "operationId": "billing.cancellation", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "too_expensive", "missing_features", "switched_service", "unused", "customer_service", "low_quality", "too_complex", "other" ] }, { "type": "null" } ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dataDeletionAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "impact": { "type": "object", "properties": { "workspaces": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "members": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "posts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduledPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automations": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connections": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "apiKeys": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaItems": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationContacts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationRuns": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "transcriptions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "workspaceNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaces", "members", "posts", "scheduledPosts", "automations", "connections", "apiKeys", "mediaItems", "mediaBytes", "automationContacts", "automationRuns", "transcriptions", "workspaceNames" ], "additionalProperties": false }, "canOfferSave": { "type": "boolean" }, "offerAmountMinor": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "offerCurrency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarBookingAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recoveryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canManageCancellation": { "type": "boolean" } }, "required": [ "id", "status", "reason", "comment", "currentPeriodEnd", "dataDeletionAt", "impact", "canOfferSave", "offerAmountMinor", "offerCurrency", "calendarReference", "calendarBookingAt", "recoveryUrl", "canManageCancellation" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/cancellation/start": { "post": { "tags": [ "Billing" ], "operationId": "billing.startCancellation", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "too_expensive", "missing_features", "switched_service", "unused", "customer_service", "low_quality", "too_complex", "other" ] }, { "type": "null" } ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dataDeletionAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "impact": { "type": "object", "properties": { "workspaces": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "members": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "posts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduledPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automations": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connections": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "apiKeys": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaItems": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationContacts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationRuns": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "transcriptions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "workspaceNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaces", "members", "posts", "scheduledPosts", "automations", "connections", "apiKeys", "mediaItems", "mediaBytes", "automationContacts", "automationRuns", "transcriptions", "workspaceNames" ], "additionalProperties": false }, "canOfferSave": { "type": "boolean" }, "offerAmountMinor": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "offerCurrency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarBookingAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recoveryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canManageCancellation": { "type": "boolean" } }, "required": [ "id", "status", "reason", "comment", "currentPeriodEnd", "dataDeletionAt", "impact", "canOfferSave", "offerAmountMinor", "offerCurrency", "calendarReference", "calendarBookingAt", "recoveryUrl", "canManageCancellation" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "too_expensive", "missing_features", "switched_service", "unused", "customer_service", "low_quality", "too_complex", "other" ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "reason" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/billing/cancellation/{id}/accept-offer": { "post": { "tags": [ "Billing" ], "operationId": "billing.acceptCancellationOffer", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "too_expensive", "missing_features", "switched_service", "unused", "customer_service", "low_quality", "too_complex", "other" ] }, { "type": "null" } ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dataDeletionAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "impact": { "type": "object", "properties": { "workspaces": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "members": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "posts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduledPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automations": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connections": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "apiKeys": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaItems": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationContacts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationRuns": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "transcriptions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "workspaceNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaces", "members", "posts", "scheduledPosts", "automations", "connections", "apiKeys", "mediaItems", "mediaBytes", "automationContacts", "automationRuns", "transcriptions", "workspaceNames" ], "additionalProperties": false }, "canOfferSave": { "type": "boolean" }, "offerAmountMinor": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "offerCurrency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarBookingAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recoveryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canManageCancellation": { "type": "boolean" } }, "required": [ "id", "status", "reason", "comment", "currentPeriodEnd", "dataDeletionAt", "impact", "canOfferSave", "offerAmountMinor", "offerCurrency", "calendarReference", "calendarBookingAt", "recoveryUrl", "canManageCancellation" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/cancellation/{id}/schedule": { "post": { "tags": [ "Billing" ], "operationId": "billing.scheduleCancellation", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "too_expensive", "missing_features", "switched_service", "unused", "customer_service", "low_quality", "too_complex", "other" ] }, { "type": "null" } ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dataDeletionAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "impact": { "type": "object", "properties": { "workspaces": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "members": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "posts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduledPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automations": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connections": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "apiKeys": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaItems": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationContacts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationRuns": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "transcriptions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "workspaceNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaces", "members", "posts", "scheduledPosts", "automations", "connections", "apiKeys", "mediaItems", "mediaBytes", "automationContacts", "automationRuns", "transcriptions", "workspaceNames" ], "additionalProperties": false }, "canOfferSave": { "type": "boolean" }, "offerAmountMinor": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "offerCurrency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarBookingAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recoveryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canManageCancellation": { "type": "boolean" } }, "required": [ "id", "status", "reason", "comment", "currentPeriodEnd", "dataDeletionAt", "impact", "canOfferSave", "offerAmountMinor", "offerCurrency", "calendarReference", "calendarBookingAt", "recoveryUrl", "canManageCancellation" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmation": { "type": "string" } }, "required": [ "confirmation" ], "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{workspaceId}/billing/cancellation/{id}/reactivate": { "post": { "tags": [ "Billing" ], "operationId": "billing.reactivateCancellation", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "too_expensive", "missing_features", "switched_service", "unused", "customer_service", "low_quality", "too_complex", "other" ] }, { "type": "null" } ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dataDeletionAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "impact": { "type": "object", "properties": { "workspaces": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "members": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "posts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduledPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automations": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connections": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "apiKeys": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaItems": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationContacts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationRuns": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "transcriptions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "workspaceNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaces", "members", "posts", "scheduledPosts", "automations", "connections", "apiKeys", "mediaItems", "mediaBytes", "automationContacts", "automationRuns", "transcriptions", "workspaceNames" ], "additionalProperties": false }, "canOfferSave": { "type": "boolean" }, "offerAmountMinor": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "offerCurrency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarBookingAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recoveryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canManageCancellation": { "type": "boolean" } }, "required": [ "id", "status", "reason", "comment", "currentPeriodEnd", "dataDeletionAt", "impact", "canOfferSave", "offerAmountMinor", "offerCurrency", "calendarReference", "calendarBookingAt", "recoveryUrl", "canManageCancellation" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/workspaces/{workspaceId}/billing/cancellation/{id}/abandon": { "post": { "tags": [ "Billing" ], "operationId": "billing.abandonCancellation", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "too_expensive", "missing_features", "switched_service", "unused", "customer_service", "low_quality", "too_complex", "other" ] }, { "type": "null" } ] }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dataDeletionAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "impact": { "type": "object", "properties": { "workspaces": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "members": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "posts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduledPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automations": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connections": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "apiKeys": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaItems": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationContacts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "automationRuns": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "transcriptions": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "workspaceNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaces", "members", "posts", "scheduledPosts", "automations", "connections", "apiKeys", "mediaItems", "mediaBytes", "automationContacts", "automationRuns", "transcriptions", "workspaceNames" ], "additionalProperties": false }, "canOfferSave": { "type": "boolean" }, "offerAmountMinor": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, { "type": "null" } ] }, "offerCurrency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarReference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calendarBookingAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recoveryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "canManageCancellation": { "type": "boolean" } }, "required": [ "id", "status", "reason", "comment", "currentPeriodEnd", "dataDeletionAt", "impact", "canOfferSave", "offerAmountMinor", "offerCurrency", "calendarReference", "calendarBookingAt", "recoveryUrl", "canManageCancellation" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "403": { "description": "ForbiddenError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "409": { "description": "ConflictError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/transcriptions": { "get": { "tags": [ "Transcriptions" ], "operationId": "transcriptions.list", "parameters": [ { "name": "limit", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false }, { "name": "cursor", "in": "query", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "required": false } ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reelId": { "type": "string" }, "reelUrl": { "type": "string" }, "text": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "type": "string" }, "durationSeconds": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "createdAt": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "reelId", "reelUrl", "text", "language", "durationSeconds", "createdAt" ], "additionalProperties": false } }, "continueCursor": { "type": "string" }, "isDone": { "type": "boolean" } }, "required": [ "page", "continueCursor", "isDone" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/transcriptions/usage": { "get": { "tags": [ "Transcriptions" ], "operationId": "transcriptions.usage", "parameters": [], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "used": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "periodEnd": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "isSortedActive": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "paidSoftLimit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "paidHardLimit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "dodoCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "used", "limit", "periodEnd", "isSortedActive", "isSubscribed", "paidSoftLimit", "paidHardLimit", "dodoCustomerId" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "404": { "description": "NotFoundError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } } } }, "/v1/transcriptions/checkout": { "post": { "tags": [ "Transcriptions" ], "operationId": "transcriptions.checkout", "parameters": [], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutUrl": { "type": "string" } }, "required": [ "checkoutUrl" ], "additionalProperties": false } } } }, "401": { "description": "UnauthorizedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "402": { "description": "QuotaExceededError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuotaExceededError" } } } }, "422": { "description": "ValidationError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationError" } } } }, "429": { "description": "RateLimitedError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": "string" } }, "required": [ "productId" ], "additionalProperties": false } } }, "required": true } } } }, "components": { "schemas": { "HealthResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "checkedAt": { "type": "string" } }, "required": [ "status", "checkedAt" ], "additionalProperties": false, "description": "Service health and the time at which it was checked" }, "HealthUnavailable": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "HealthUnavailable" ] }, "message": { "type": "string" }, "retryable": { "type": "boolean" } }, "required": [ "_tag", "message", "retryable" ], "additionalProperties": false }, "MeResponse": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "externalId", "email", "name", "imageUrl" ], "additionalProperties": false }, "personalWorkspace": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "user", "personalWorkspace" ], "additionalProperties": false }, "UnauthorizedError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "UnauthorizedError" ] }, "message": { "type": "string" }, "details": { "anyOf": [ { "type": "object" }, { "type": "array" } ] } }, "required": [ "code", "message", "details" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "RateLimitedError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "RateLimitedError" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "retryAfter": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] } }, "required": [ "retryAfter" ], "additionalProperties": false } }, "required": [ "code", "message", "details" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "QuotaExceededError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "QuotaExceededError" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "resource": { "type": "string" }, "limit": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "current": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, "upgradeUrl": { "type": "string" } }, "required": [ "resource", "limit", "current", "upgradeUrl" ], "additionalProperties": false } }, "required": [ "code", "message", "details" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "WorkspaceOverviewResponse": { "type": "object", "properties": { "generatedAt": { "type": "string" }, "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] }, "isPersonal": { "type": "boolean" } }, "required": [ "id", "name", "role", "isPersonal" ], "additionalProperties": false }, "setup": { "type": "object", "properties": { "connectedPlatforms": { "type": "array", "items": { "type": "string" } }, "outstandingAction": { "anyOf": [ { "type": "string", "enum": [ "connect_account", "complete_payment" ] }, { "type": "null" } ] }, "onboardingComplete": { "type": "boolean" } }, "required": [ "connectedPlatforms", "outstandingAction", "onboardingComplete" ], "additionalProperties": false }, "accounts": { "type": "object", "properties": { "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "expiringSoon": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "total", "expiringSoon" ], "additionalProperties": false }, "subscription": { "type": "object", "properties": { "plan": { "type": "string" }, "status": { "type": "string" }, "paid": { "type": "boolean" } }, "required": [ "plan", "status", "paid" ], "additionalProperties": false }, "usage": { "type": "object", "properties": { "socialAccounts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "monthlyPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "mediaStorageBytes": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "apiRequestsPerMonth": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "dmsSent": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "dmsSkipped": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "transcriptionsUsed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "socialAccounts", "monthlyPosts", "mediaStorageBytes", "apiRequestsPerMonth", "dmsSent", "dmsSkipped", "transcriptionsUsed" ], "additionalProperties": false }, "publishing": { "type": "object", "properties": { "totalPosts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "drafts": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "pendingReview": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduled": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "publishing": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "published": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "partiallyFailed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "failed": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "scheduledNextSevenDays": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "publishedLastThirtyDays": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "totalPosts", "drafts", "pendingReview", "scheduled", "publishing", "published", "partiallyFailed", "failed", "scheduledNextSevenDays", "publishedLastThirtyDays" ], "additionalProperties": false }, "reviews": { "type": "object", "properties": { "pending": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "pending" ], "additionalProperties": false } }, "required": [ "generatedAt", "workspace", "setup", "accounts", "subscription", "usage", "publishing", "reviews" ], "additionalProperties": false }, "ForbiddenError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "ForbiddenError" ] }, "message": { "type": "string" }, "details": { "anyOf": [ { "type": "object" }, { "type": "array" } ] } }, "required": [ "code", "message", "details" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "NotFoundError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "NotFoundError" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "resource": { "type": "string" } }, "required": [ "resource" ], "additionalProperties": false } }, "required": [ "code", "message", "details" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "WorkspaceMembershipItem": { "type": "object", "properties": { "workspaceId": { "type": "string" }, "name": { "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isPersonal": { "type": "boolean" }, "role": { "type": "string", "enum": [ "owner", "admin", "editor", "viewer" ] } }, "required": [ "workspaceId", "name", "slug", "isPersonal", "role" ], "additionalProperties": false }, "MeWorkspacesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMembershipItem" } }, "total": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "limit": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "offset": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "NaN" ] }, { "type": "string", "enum": [ "Infinity" ] }, { "type": "string", "enum": [ "-Infinity" ] } ] }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "data", "total", "limit", "offset" ], "additionalProperties": false }, "ValidationError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "ValidationError" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } } }, "required": [ "issues" ], "additionalProperties": false } }, "required": [ "code", "message", "details" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "ConflictError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "ConflictError" ] }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "resource": { "type": "string" } }, "required": [ "resource" ], "additionalProperties": false } }, "required": [ "code", "message", "details" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "AnalyticsProviderError": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AnalyticsProviderError" ] }, "message": { "type": "string" }, "retryable": { "type": "boolean" } }, "required": [ "_tag", "message", "retryable" ], "additionalProperties": false } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "Bearer" } } }, "security": [], "tags": [ { "name": "health" }, { "name": "me" }, { "name": "Posts" }, { "name": "Reviews" }, { "name": "Media" }, { "name": "Connections" }, { "name": "Workspace administration" }, { "name": "Analytics" }, { "name": "Automations" }, { "name": "Billing" }, { "name": "Transcriptions" } ], "servers": [ { "url": "https://api.delulu.social" } ] }