{ "openapi": "3.1.0", "info": { "title": "Octospark Agent API", "version": "0.1.0", "summary": "Public API surface for Octospark CLI, MCP, and SDK clients.", "description": "Filtered OpenAPI contract for the operations exposed through Octospark CLI, MCP, and generated SDK documentation." }, "paths": { "/v1/organizations": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.listOrganizations", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "billingEmail", "onboardingData", "stripeCustomerId", "stripeSubscriptionId", "stripePaymentMethodId", "stripeMeteredSubscriptionItemId", "creditsBalance", "reservedCredits", "autoRechargeEnabled", "autoRechargeThreshold", "autoRechargeAmount", "isSubscribed", "subscriptionStatus", "subscriptionPlan", "subscriptionStartedAt", "subscriptionEndsAt", "subscriptionCurrentPeriodEnd", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "billingEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "onboardingData": { "anyOf": [ { "type": "object", "required": [ "version", "status", "currentStep", "completedSteps" ], "properties": { "version": { "type": "number", "enum": [ 1 ] }, "status": { "type": "string", "enum": [ "in_progress", "completed" ] }, "currentStep": { "type": "string", "enum": [ "organization_profile", "job_role", "workspace_setup", "goals", "mcp_cli_setup", "spend_cap", "completed" ] }, "completedSteps": { "type": "array", "items": { "type": "string", "enum": [ "organization_profile", "job_role", "workspace_setup", "goals", "mcp_cli_setup", "spend_cap", "completed" ] } }, "organizationProfile": { "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "jobRole": { "type": "string", "enum": [ "developer_or_technical_founder", "founder_or_owner", "marketing_or_social", "agency_or_client_services", "operations_or_admin", "other" ] } }, "additionalProperties": false }, "workspaceProfile": { "type": "object", "required": [ "teamName", "website" ], "properties": { "teamName": { "type": "string", "description": "a string at most 64 character(s) long", "title": "maxLength(64)", "minLength": 2, "maxLength": 64 }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "goals": { "type": "object", "required": [ "primaryGoal", "teamSize" ], "properties": { "primaryGoal": { "type": "string", "enum": [ "vibe_marketing", "social_media_marketing", "automated_campaigns_for_clients" ] }, "teamSize": { "type": "string", "enum": [ "1-5", "6-20", "21-50", "51+" ] } }, "additionalProperties": false }, "completedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripePaymentMethodId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stripeMeteredSubscriptionItemId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "creditsBalance": { "type": "number" }, "reservedCredits": { "type": "number" }, "autoRechargeEnabled": { "type": "boolean" }, "autoRechargeThreshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "autoRechargeAmount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "isSubscribed": { "type": "boolean" }, "subscriptionStatus": { "type": "string", "enum": [ "active", "inactive", "trialing", "past_due", "canceled", "paused", "unpaid" ] }, "subscriptionPlan": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionStartedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionCurrentPeriodEnd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.organizationsListOrganizations({\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.organizations_list_organizations()" }, { "lang": "CLI", "label": "CLI", "source": "octospark orgs list" } ], "summary": "List organizations", "x-displayName": "List organizations" } }, "/v1/teams": { "get": { "tags": [ "Teams" ], "operationId": "teams.listTeams", "parameters": [ { "name": "organizationId", "in": "query", "schema": { "$ref": "#/components/schemas/UUID" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "organizationId", "name", "website", "brandSettings", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "organizationId": { "$ref": "#/components/schemas/UUID" }, "name": { "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brandSettings": { "anyOf": [ { "type": "object", "required": [ "colors", "brandGuidelines", "industry", "targetAudience" ], "properties": { "colors": { "type": "object", "required": [ "primary", "secondary", "accent", "background", "text" ], "properties": { "primary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "secondary": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "accent": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "background": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" }, "text": { "type": "string", "description": "a string matching the pattern ^#[0-9a-fA-F]{6}$", "pattern": "^#[0-9a-fA-F]{6}$" } }, "additionalProperties": false }, "brandGuidelines": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 }, "industry": { "type": "string", "description": "a string at most 100 character(s) long", "title": "maxLength(100)", "maxLength": 100 }, "targetAudience": { "type": "string", "description": "a string at most 500 character(s) long", "title": "maxLength(500)", "maxLength": 500 } }, "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-invariants": [ "INV-ORG-001" ], "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.teamsListTeams({\n query: {\n \"organizationId\": process.env.OCTOSPARK_ORGANIZATION_ID ?? \"organizationId\",\n },\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.teams_list_teams(\n query={\n \"organizationId\": os.environ.get(\"OCTOSPARK_ORGANIZATION_ID\", \"organizationId\"),\n }\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark teams list \\\n --request '{\"query\":{\"organizationId\":\"organizationId\"}}'" } ], "summary": "List teams", "x-displayName": "List teams" } }, "/v1/teams/{teamId}/analytics/accounts": { "get": { "tags": [ "Social" ], "operationId": "social.listAccountAnalytics", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "socialAccountId", "provider", "displayName", "profileHandle", "status", "capabilityStatus", "uiEnabled" ], "properties": { "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "displayName": { "type": "string" }, "profileHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "available", "disabled", "failed", "unsupported" ] }, "capabilityStatus": { "type": "string" }, "uiEnabled": { "type": "boolean" }, "collectedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "metrics": { "anyOf": [ { "type": "object", "required": [ "followerCount", "followingCount", "subscriberCount", "postCount", "viewCount", "likeCount", "commentCount", "shareCount", "saveCount", "reachCount", "impressionCount", "profileViewCount" ], "properties": { "followerCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "followingCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "subscriberCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "postCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "viewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "likeCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "commentCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shareCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "saveCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reachCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "impressionCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "profileViewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialListAccountAnalytics({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_list_account_analytics(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark analytics posts \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" } ], "summary": "List account analytics", "x-displayName": "List account analytics" } }, "/v1/teams/{teamId}/analytics/aggregates": { "get": { "tags": [ "Social" ], "operationId": "social.getAnalyticsAggregates", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "from", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "query", "schema": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "period", "totals", "byPlatform", "byWeek" ], "properties": { "period": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "additionalProperties": false }, "totals": { "type": "object", "required": [ "likeCount", "commentCount", "shareCount", "saveCount", "impressionCount", "reachCount", "postCount", "averageEngagementRate" ], "properties": { "likeCount": { "type": "number" }, "commentCount": { "type": "number" }, "shareCount": { "type": "number" }, "saveCount": { "type": "number" }, "impressionCount": { "type": "number" }, "reachCount": { "type": "number" }, "postCount": { "type": "number" }, "averageEngagementRate": { "type": "number" } }, "additionalProperties": false }, "byPlatform": { "type": "array", "items": { "type": "object", "required": [ "platform", "likeCount", "commentCount", "shareCount", "saveCount", "impressionCount", "reachCount", "postCount", "averageEngagementRate" ], "properties": { "platform": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "likeCount": { "type": "number" }, "commentCount": { "type": "number" }, "shareCount": { "type": "number" }, "saveCount": { "type": "number" }, "impressionCount": { "type": "number" }, "reachCount": { "type": "number" }, "postCount": { "type": "number" }, "averageEngagementRate": { "type": "number" } }, "additionalProperties": false } }, "byWeek": { "type": "array", "items": { "type": "object", "required": [ "weekStart", "platform", "likeCount", "commentCount", "shareCount", "saveCount", "impressionCount", "postCount", "averageEngagementRate" ], "properties": { "weekStart": { "type": "string" }, "platform": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "likeCount": { "type": "number" }, "commentCount": { "type": "number" }, "shareCount": { "type": "number" }, "saveCount": { "type": "number" }, "impressionCount": { "type": "number" }, "postCount": { "type": "number" }, "averageEngagementRate": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialGetAnalyticsAggregates({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n query: {\n \"from\": process.env.OCTOSPARK_FROM ?? \"from\",\n \"to\": process.env.OCTOSPARK_TO ?? \"to\",\n },\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_get_analytics_aggregates(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n query={\n \"from\": os.environ.get(\"OCTOSPARK_FROM\", \"from\"),\n \"to\": os.environ.get(\"OCTOSPARK_TO\", \"to\"),\n }\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark analytics summary \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"query\":{\"from\":\"from\",\"to\":\"to\"}}'" } ], "summary": "Analytics aggregates", "x-displayName": "Analytics aggregates" } }, "/v1/teams/{teamId}/posts": { "get": { "tags": [ "Social" ], "operationId": "social.listPosts", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "idea", "proposed_render", "draft", "approved", "rejected", "archived", "deleted" ] }, "required": false }, { "name": "provider", "in": "query", "schema": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "required": false }, { "name": "scheduledFrom", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "scheduledTo", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "postType", "title", "status", "text", "assetIds", "contentPayloadId", "latestScheduledPost", "saveDestination", "saveMessage", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "postType": { "type": "string", "enum": [ "text_post", "text_image", "text_video", "green_screen_meme" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "idea", "proposed_render", "draft", "approved", "rejected", "archived", "deleted" ] }, "text": { "type": "string" }, "assetIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } }, "postInput": { "anyOf": [ { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "posts" ], "properties": { "kind": { "type": "string", "enum": [ "thread" ] }, "posts": { "type": "array", "items": { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, "description": "an array of at least 2 item(s)", "title": "minItems(2)", "minItems": 2 } }, "additionalProperties": false } ] }, "postPublishActions": { "type": "object", "required": [], "properties": { "firstComment": { "anyOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, { "type": "null" } ] }, "engagementCommentTrigger": { "anyOf": [ { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "repostAfter": { "anyOf": [ { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "recurrenceIntervalDays": { "anyOf": [ { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "contentPayloadId": { "$ref": "#/components/schemas/UUID" }, "latestScheduledPost": { "anyOf": [ { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "saveDestination": { "type": "string", "enum": [ "queue", "drafts" ] }, "saveMessage": { "type": "string", "enum": [ "Saved to Queue", "Saved to Drafts" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialListPosts({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_list_posts(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark posts list \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" } ], "summary": "List posts", "x-displayName": "List posts" }, "post": { "tags": [ "Social" ], "operationId": "social.createPost", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "postType", "title", "status", "text", "assetIds", "contentPayloadId", "latestScheduledPost", "saveDestination", "saveMessage", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "postType": { "type": "string", "enum": [ "text_post", "text_image", "text_video", "green_screen_meme" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "idea", "proposed_render", "draft", "approved", "rejected", "archived", "deleted" ] }, "text": { "type": "string" }, "assetIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } }, "postInput": { "anyOf": [ { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "posts" ], "properties": { "kind": { "type": "string", "enum": [ "thread" ] }, "posts": { "type": "array", "items": { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, "description": "an array of at least 2 item(s)", "title": "minItems(2)", "minItems": 2 } }, "additionalProperties": false } ] }, "postPublishActions": { "type": "object", "required": [], "properties": { "firstComment": { "anyOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, { "type": "null" } ] }, "engagementCommentTrigger": { "anyOf": [ { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "repostAfter": { "anyOf": [ { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "recurrenceIntervalDays": { "anyOf": [ { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "contentPayloadId": { "$ref": "#/components/schemas/UUID" }, "latestScheduledPost": { "anyOf": [ { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "saveDestination": { "type": "string", "enum": [ "queue", "drafts" ] }, "saveMessage": { "type": "string", "enum": [ "Saved to Queue", "Saved to Drafts" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postType": { "type": "string", "enum": [ "text_post", "text_image", "text_video", "green_screen_meme" ] }, "text": { "type": "string" }, "postInput": { "anyOf": [ { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "posts" ], "properties": { "kind": { "type": "string", "enum": [ "thread" ] }, "posts": { "type": "array", "items": { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, "description": "an array of at least 2 item(s)", "title": "minItems(2)", "minItems": 2 } }, "additionalProperties": false } ] }, "assetIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } }, "postPublishActions": { "type": "object", "required": [], "properties": { "firstComment": { "anyOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, { "type": "null" } ] }, "engagementCommentTrigger": { "anyOf": [ { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "repostAfter": { "anyOf": [ { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "recurrenceIntervalDays": { "anyOf": [ { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialCreatePost({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_create_post(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark posts create \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"body\":{}}'" } ], "summary": "Create post", "x-displayName": "Create post" } }, "/v1/teams/{teamId}/posts/{postId}": { "get": { "tags": [ "Social" ], "operationId": "social.getPost", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "postType", "title", "status", "text", "assetIds", "contentPayloadId", "latestScheduledPost", "saveDestination", "saveMessage", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "postType": { "type": "string", "enum": [ "text_post", "text_image", "text_video", "green_screen_meme" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "idea", "proposed_render", "draft", "approved", "rejected", "archived", "deleted" ] }, "text": { "type": "string" }, "assetIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } }, "postInput": { "anyOf": [ { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "posts" ], "properties": { "kind": { "type": "string", "enum": [ "thread" ] }, "posts": { "type": "array", "items": { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, "description": "an array of at least 2 item(s)", "title": "minItems(2)", "minItems": 2 } }, "additionalProperties": false } ] }, "postPublishActions": { "type": "object", "required": [], "properties": { "firstComment": { "anyOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, { "type": "null" } ] }, "engagementCommentTrigger": { "anyOf": [ { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "repostAfter": { "anyOf": [ { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "recurrenceIntervalDays": { "anyOf": [ { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "contentPayloadId": { "$ref": "#/components/schemas/UUID" }, "latestScheduledPost": { "anyOf": [ { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "saveDestination": { "type": "string", "enum": [ "queue", "drafts" ] }, "saveMessage": { "type": "string", "enum": [ "Saved to Queue", "Saved to Drafts" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialGetPost({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_get_post(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark posts get \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"}}'" } ], "summary": "Post", "x-displayName": "Post" }, "patch": { "tags": [ "Social" ], "operationId": "social.updatePost", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "postType", "title", "status", "text", "assetIds", "contentPayloadId", "latestScheduledPost", "saveDestination", "saveMessage", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "postType": { "type": "string", "enum": [ "text_post", "text_image", "text_video", "green_screen_meme" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "idea", "proposed_render", "draft", "approved", "rejected", "archived", "deleted" ] }, "text": { "type": "string" }, "assetIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } }, "postInput": { "anyOf": [ { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "posts" ], "properties": { "kind": { "type": "string", "enum": [ "thread" ] }, "posts": { "type": "array", "items": { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, "description": "an array of at least 2 item(s)", "title": "minItems(2)", "minItems": 2 } }, "additionalProperties": false } ] }, "postPublishActions": { "type": "object", "required": [], "properties": { "firstComment": { "anyOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, { "type": "null" } ] }, "engagementCommentTrigger": { "anyOf": [ { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "repostAfter": { "anyOf": [ { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "recurrenceIntervalDays": { "anyOf": [ { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "contentPayloadId": { "$ref": "#/components/schemas/UUID" }, "latestScheduledPost": { "anyOf": [ { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "saveDestination": { "type": "string", "enum": [ "queue", "drafts" ] }, "saveMessage": { "type": "string", "enum": [ "Saved to Queue", "Saved to Drafts" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postType": { "type": "string", "enum": [ "text_post", "text_image", "text_video", "green_screen_meme" ] }, "text": { "type": "string" }, "postInput": { "anyOf": [ { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "posts" ], "properties": { "kind": { "type": "string", "enum": [ "thread" ] }, "posts": { "type": "array", "items": { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, "description": "an array of at least 2 item(s)", "title": "minItems(2)", "minItems": 2 } }, "additionalProperties": false } ] }, "assetIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } }, "postPublishActions": { "type": "object", "required": [], "properties": { "firstComment": { "anyOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, { "type": "null" } ] }, "engagementCommentTrigger": { "anyOf": [ { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "repostAfter": { "anyOf": [ { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "recurrenceIntervalDays": { "anyOf": [ { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialUpdatePost({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_update_post(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark social update-post \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"},\"body\":{}}'" } ], "summary": "Update post", "x-displayName": "Update post" }, "delete": { "tags": [ "Social" ], "operationId": "social.deletePost", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "alsoDeleteFromPlatform", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "deleted", "platformDelete" ], "properties": { "deleted": { "type": "boolean" }, "platformDelete": { "type": "object", "required": [ "status", "provider", "platformPostId", "message" ], "properties": { "status": { "type": "string", "enum": [ "not_requested", "deleted", "skipped", "failed" ] }, "provider": { "anyOf": [ { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialDeletePost({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_delete_post(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark posts delete \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"}}'" } ], "summary": "Delete post", "x-displayName": "Delete post" } }, "/v1/teams/{teamId}/posts/{postId}/move-to-draft": { "post": { "tags": [ "Social" ], "operationId": "social.movePostToDraft", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "postType", "title", "status", "text", "assetIds", "contentPayloadId", "latestScheduledPost", "saveDestination", "saveMessage", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "postType": { "type": "string", "enum": [ "text_post", "text_image", "text_video", "green_screen_meme" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "idea", "proposed_render", "draft", "approved", "rejected", "archived", "deleted" ] }, "text": { "type": "string" }, "assetIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } }, "postInput": { "anyOf": [ { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "posts" ], "properties": { "kind": { "type": "string", "enum": [ "thread" ] }, "posts": { "type": "array", "items": { "type": "object", "required": [ "kind", "text" ], "properties": { "kind": { "type": "string", "enum": [ "atomic" ] }, "text": { "type": "string" }, "attachments": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "kind", "asset" ], "properties": { "kind": { "type": "string", "enum": [ "media" ] }, "asset": { "type": "object", "required": [ "assetId" ], "properties": { "assetId": { "$ref": "#/components/schemas/UUID" }, "mimeType": { "type": "string" }, "byteSize": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "durationSeconds": { "type": "number" }, "thumbnailUrl": { "type": "string" }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "mediaType": { "type": "string", "enum": [ "image", "video", "gif", "document" ] }, "altText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "kind", "url" ], "properties": { "kind": { "type": "string", "enum": [ "link" ] }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } } }, "additionalProperties": false }, "description": "an array of at least 2 item(s)", "title": "minItems(2)", "minItems": 2 } }, "additionalProperties": false } ] }, "postPublishActions": { "type": "object", "required": [], "properties": { "firstComment": { "anyOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, { "type": "null" } ] }, "engagementCommentTrigger": { "anyOf": [ { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "repostAfter": { "anyOf": [ { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "recurrenceIntervalDays": { "anyOf": [ { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "contentPayloadId": { "$ref": "#/components/schemas/UUID" }, "latestScheduledPost": { "anyOf": [ { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "saveDestination": { "type": "string", "enum": [ "queue", "drafts" ] }, "saveMessage": { "type": "string", "enum": [ "Saved to Queue", "Saved to Drafts" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialMovePostToDraft({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_move_post_to_draft(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark social move-post-to-draft \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"}}'" } ], "summary": "Move post to draft", "x-displayName": "Move post to draft" } }, "/v1/teams/{teamId}/posts/{postId}/performance": { "get": { "tags": [ "Social" ], "operationId": "social.getPostPerformance", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "scheduledPostId", "platform", "collectionStatus", "current", "derivedMetrics", "snapshots" ], "properties": { "scheduledPostId": { "$ref": "#/components/schemas/UUID" }, "platform": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "collectionStatus": { "type": "string", "enum": [ "pending", "collecting", "completed", "failed", "stale" ] }, "current": { "type": "object", "required": [ "likeCount", "commentCount", "shareCount", "saveCount", "impressionCount", "reachCount" ], "properties": { "likeCount": { "type": "number" }, "commentCount": { "type": "number" }, "shareCount": { "type": "number" }, "saveCount": { "type": "number" }, "impressionCount": { "type": "number" }, "reachCount": { "type": "number" } }, "additionalProperties": false }, "derivedMetrics": { "type": "object", "required": [ "engagementRate", "performanceScore", "viralityScore", "qualityScore", "banditReward" ], "properties": { "engagementRate": { "type": "number" }, "performanceScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "viralityScore": { "type": "number" }, "qualityScore": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "banditReward": { "type": "number" } }, "additionalProperties": false }, "lastCollectedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "snapshots": { "type": "array", "items": { "type": "object", "required": [ "hoursSincePost", "snapshotTakenAt", "likeCount", "commentCount", "shareCount", "saveCount", "impressionCount", "reachCount" ], "properties": { "hoursSincePost": { "$ref": "#/components/schemas/Int" }, "snapshotTakenAt": { "type": "string" }, "likeCount": { "type": "number" }, "commentCount": { "type": "number" }, "shareCount": { "type": "number" }, "saveCount": { "type": "number" }, "impressionCount": { "type": "number" }, "reachCount": { "type": "number" }, "collectionError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialGetPostPerformance({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_get_post_performance(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark analytics post \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"}}'" } ], "summary": "Post performance", "x-displayName": "Post performance" } }, "/v1/teams/{teamId}/posts/{postId}/post-now": { "post": { "tags": [ "Social" ], "operationId": "social.postNow", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "socialAccountId" ], "properties": { "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] } }, "firstComment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, "engagementCommentTrigger": { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, "repostAfter": { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, "recurrenceIntervalDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialPostNow({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_post_now(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark posts publish \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"},\"body\":{}}'" } ], "summary": "Post now", "x-displayName": "Post now" } }, "/v1/teams/{teamId}/posts/{postId}/post-now-multi": { "post": { "tags": [ "Social" ], "operationId": "social.postNowMulti", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "outcome" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "socialAccountId" ], "properties": { "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "scheduledPost": { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }, "error": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "outcome": { "type": "object", "required": [ "status", "totalCount", "successCount", "failureCount" ], "properties": { "status": { "type": "string", "enum": [ "empty", "all_failed", "partially_failed", "none_failed" ] }, "totalCount": { "type": "number" }, "successCount": { "type": "number" }, "failureCount": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "socialAccountIds" ], "properties": { "socialAccountIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" }, "description": "an array of at least 1 item(s)", "title": "minItems(1)", "minItems": 1 }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] } }, "platformSettingsBySocialAccountId": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] } } }, "firstComment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, "engagementCommentTrigger": { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, "repostAfter": { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, "recurrenceIntervalDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialPostNowMulti({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_post_now_multi(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark social post-now-multi \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"},\"body\":{}}'" } ], "summary": "Post now multi", "x-displayName": "Post now multi" } }, "/v1/teams/{teamId}/posts/{postId}/schedule": { "post": { "tags": [ "Social" ], "operationId": "social.schedulePost", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "socialAccountId", "scheduledAt" ], "properties": { "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] } }, "firstComment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, "engagementCommentTrigger": { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, "repostAfter": { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, "recurrenceIntervalDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialSchedulePost({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_schedule_post(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark posts schedule \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"},\"body\":{}}'" } ], "summary": "Schedule post", "x-displayName": "Schedule post" } }, "/v1/teams/{teamId}/posts/{postId}/schedule-multi": { "post": { "tags": [ "Social" ], "operationId": "social.scheduleMultiPost", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "postId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "outcome" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "socialAccountId" ], "properties": { "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "scheduledPost": { "type": "object", "required": [ "id", "teamId", "contentItemId", "socialAccountId", "provider", "status", "scheduledAt", "timezone", "platformPostId", "platformSettings", "publishResults", "providerPublishState", "errorCode", "errorMessage", "errorCategory", "workflowId", "workflowRunId", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "contentItemId": { "$ref": "#/components/schemas/UUID" }, "socialAccountId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "draft", "scheduled", "publishing", "published", "failed", "cancelled" ] }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "publishResults": { "anyOf": [ { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, { "type": "null" } ] }, "providerPublishState": { "type": "object", "required": [ "provider", "status", "requiresPolling", "publishId", "platformPostId", "providerStatus", "pollingReason", "uploadProgress", "failureCode", "failureCategory" ], "properties": { "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "status": { "type": "string", "enum": [ "not_started", "pending", "published", "failed", "unknown" ] }, "requiresPolling": { "type": "boolean" }, "publishId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformPostId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "providerStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pollingReason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "uploadProgress": { "anyOf": [ { "type": "object", "required": [ "nextByteStart", "uploadSize" ], "properties": { "nextByteStart": { "type": "number" }, "uploadSize": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "failureCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] } }, "additionalProperties": false }, "errorCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "errorCategory": { "anyOf": [ { "type": "string", "enum": [ "rate_limited", "transient", "auth", "validation", "permanent" ] }, { "type": "null" } ] }, "workflowId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflowRunId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }, "error": { "type": "object", "required": [ "message" ], "properties": { "message": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "outcome": { "type": "object", "required": [ "status", "totalCount", "successCount", "failureCount" ], "properties": { "status": { "type": "string", "enum": [ "empty", "all_failed", "partially_failed", "none_failed" ] }, "totalCount": { "type": "number" }, "successCount": { "type": "number" }, "failureCount": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "socialAccountIds", "scheduledAt" ], "properties": { "socialAccountIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" }, "description": "an array of at least 1 item(s)", "title": "minItems(1)", "minItems": 1 }, "scheduledAt": { "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "platformSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] } }, "platformSettingsBySocialAccountId": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "type": "string" } } ] } } }, "firstComment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, "engagementCommentTrigger": { "type": "object", "required": [ "likeThreshold", "windowHours", "comment" ], "properties": { "likeThreshold": { "$ref": "#/components/schemas/Int", "description": "a number greater than or equal to 1", "title": "greaterThanOrEqualTo(1)", "minimum": 1 }, "windowHours": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 720", "title": "between(1, 720)", "minimum": 1, "maximum": 720 }, "comment": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "mediaIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false }, "repostAfter": { "type": "object", "required": [ "offsetDays", "mode" ], "properties": { "offsetDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 30", "title": "between(1, 30)", "minimum": 1, "maximum": 30 }, "mode": { "type": "string", "enum": [ "retweet", "quote" ] }, "text": { "type": "string" } }, "additionalProperties": false }, "recurrenceIntervalDays": { "$ref": "#/components/schemas/Int", "description": "a number between 1 and 365", "title": "between(1, 365)", "minimum": 1, "maximum": 365 }, "recurrenceEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialScheduleMultiPost({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n postId: process.env.OCTOSPARK_POST_ID ?? \"postId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_schedule_multi_post(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n postId=os.environ.get(\"OCTOSPARK_POST_ID\", \"postId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark social schedule-multi-post \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"postId\":\"postId\"},\"body\":{}}'" } ], "summary": "Schedule multi post", "x-displayName": "Schedule multi post" } }, "/v1/teams/{teamId}/posts/performance": { "get": { "tags": [ "Social" ], "operationId": "social.listPostPerformance", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "sortBy", "in": "query", "schema": { "type": "string", "enum": [ "engagement_rate", "performance_score", "virality_score" ] }, "required": false }, { "name": "from", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "platform", "in": "query", "schema": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "scheduledPostId", "platform", "current", "engagementRate", "performanceScore" ], "properties": { "scheduledPostId": { "$ref": "#/components/schemas/UUID" }, "platform": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "current": { "type": "object", "required": [ "likeCount", "commentCount", "shareCount", "saveCount", "impressionCount", "reachCount" ], "properties": { "likeCount": { "type": "number" }, "commentCount": { "type": "number" }, "shareCount": { "type": "number" }, "saveCount": { "type": "number" }, "impressionCount": { "type": "number" }, "reachCount": { "type": "number" } }, "additionalProperties": false }, "engagementRate": { "type": "number" }, "performanceScore": { "type": "number", "description": "a number between 0 and 100", "title": "between(0, 100)", "minimum": 0, "maximum": 100 }, "lastCollectedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialListPostPerformance({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_list_post_performance(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark analytics posts \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"query\":{\"from\":\"from\",\"to\":\"to\"}}'" } ], "summary": "List post performance", "x-displayName": "List post performance" } }, "/v1/teams/{teamId}/social-accounts": { "get": { "tags": [ "Social" ], "operationId": "social.listSocialAccounts", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "provider", "providerAccountId", "displayName", "profileHandle", "profileImageUrl", "accountSubType", "status", "scopes", "providerSettings", "capabilities", "connectedAt", "disconnectedAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "providerAccountId": { "type": "string" }, "displayName": { "type": "string" }, "profileHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profileImageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accountSubType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "connected", "disabled", "refresh_needed", "disconnected" ] }, "scopes": { "type": "array", "items": { "type": "string" } }, "providerSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "capabilities": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "connectedAt": { "type": "string" }, "disconnectedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialListSocialAccounts({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_list_social_accounts(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark accounts list \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" } ], "summary": "List social accounts", "x-displayName": "List social accounts" } }, "/v1/teams/{teamId}/social-accounts/{id}": { "get": { "tags": [ "Social" ], "operationId": "social.getSocialAccount", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "provider", "providerAccountId", "displayName", "profileHandle", "profileImageUrl", "accountSubType", "status", "scopes", "providerSettings", "capabilities", "connectedAt", "disconnectedAt", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "provider": { "type": "string", "enum": [ "x", "tiktok", "instagram", "facebook", "youtube", "linkedin", "threads" ] }, "providerAccountId": { "type": "string" }, "displayName": { "type": "string" }, "profileHandle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profileImageUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accountSubType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "connected", "disabled", "refresh_needed", "disconnected" ] }, "scopes": { "type": "array", "items": { "type": "string" } }, "providerSettings": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "capabilities": { "type": "object", "required": [], "properties": {}, "additionalProperties": { "$id": "/schemas/unknown", "title": "unknown" } }, "connectedAt": { "type": "string" }, "disconnectedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.socialGetSocialAccount({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n id: process.env.OCTOSPARK_ID ?? \"id\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.social_get_social_account(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n id=os.environ.get(\"OCTOSPARK_ID\", \"id\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark accounts get \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"id\":\"id\"}}'" } ], "summary": "Social account", "x-displayName": "Social account" } }, "/v1/teams/{teamId}/assets": { "get": { "tags": [ "Assets" ], "operationId": "assets.listAssets", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false }, { "name": "filter[assetType]", "in": "query", "schema": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "type", "width", "height", "format" ], "properties": { "type": { "type": "string", "enum": [ "image" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "format": { "type": "string" }, "colorSpace": { "type": "string" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "video" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "duration": { "type": "number" }, "codec": { "type": "string" }, "bitrate": { "type": "number" }, "fps": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "audio" ] }, "duration": { "type": "number" }, "sampleRate": { "type": "number" }, "channels": { "type": "number" }, "codec": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "frameCount" ], "properties": { "type": { "type": "string", "enum": [ "gif" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "frameCount": { "type": "number" }, "duration": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "format" ], "properties": { "type": { "type": "string", "enum": [ "document" ] }, "pageCount": { "type": "number" }, "format": { "type": "string" } }, "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "chromaKey", "analysisVersion", "confidence", "chromaKeyProfiles", "subjectAnalysis", "aspectRatioProfiles", "captioning", "audio", "composition" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "green_screen_template" ] }, "chromaKey": { "type": "object", "required": [ "keyColor", "ffmpegSimilarity", "ffmpegBlend", "spillRisk" ], "properties": { "keyColor": { "type": "string", "enum": [ "#00ff00" ] }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" }, "spillRisk": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "additionalProperties": false }, "analysisVersion": { "type": "number" }, "confidence": { "type": "number" }, "chromaKeyProfiles": { "type": "object", "required": [ "baseline", "fallback" ], "properties": { "baseline": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "fallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "confidence": { "type": "number" }, "strongFallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "subjectAnalysis": { "type": "object", "required": [ "sampleCount", "sampleTimestampsSeconds", "representativeBounds", "subjectHeightFraction", "subjectWidthFraction", "centerXFraction", "bottomYFraction", "cropRisk", "faceRegion", "confidence" ], "properties": { "sampleCount": { "type": "number" }, "sampleTimestampsSeconds": { "type": "array", "items": { "type": "number" } }, "representativeBounds": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "defaultSubjectBounds": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "subjectHeightFraction": { "type": "number" }, "subjectWidthFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "bottomYFraction": { "type": "number" }, "cropRisk": { "type": "object", "required": [ "top", "bottom", "left", "right" ], "properties": { "top": { "type": "number" }, "bottom": { "type": "number" }, "left": { "type": "number" }, "right": { "type": "number" } }, "additionalProperties": false }, "defaultFaceRegion": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRange": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRangeDelta": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "additionalProperties": false }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegion": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "confidence": { "type": "number" } }, "additionalProperties": false }, "aspectRatioProfiles": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "captioning": { "type": "object", "required": [ "preferredCaptionZones", "forbiddenCaptionZones", "subjectBoundsByAspectRatio", "faceRegionByAspectRatio", "captionSafeBandsByAspectRatio", "preferredZonesByAspectRatio", "forbiddenZonesByAspectRatio" ], "properties": { "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "16:9": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "1:1": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "4:5": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "preferredZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "forbiddenZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "audio": { "type": "object", "required": [ "hasAudio", "likelyHasMusic", "likelyHasSpeech", "needsMusic" ], "properties": { "hasAudio": { "type": "boolean" }, "likelyHasMusic": { "type": "boolean" }, "likelyHasSpeech": { "type": "boolean" }, "needsMusic": { "type": "boolean" } }, "additionalProperties": false }, "composition": { "type": "object", "required": [ "safeCaptionZones", "captionSafeBandsByAspectRatio", "recommendedBackgroundTags", "recommendedMusicTags", "recommendedSoundEffectTags" ], "properties": { "safeCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "recommendedBackgroundTags": { "type": "array", "items": { "type": "string" } }, "recommendedMusicTags": { "type": "array", "items": { "type": "string" } }, "recommendedSoundEffectTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "aspectRatioCategory" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "background" ] }, "aspectRatioCategory": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5", "other" ] }, "dominantColors": { "type": "array", "items": { "type": "string" } }, "isLoopable": { "type": "boolean" }, "textSafeZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "mood", "energyLevel" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "music" ] }, "mood": { "type": "array", "items": { "type": "string" } }, "energyLevel": { "type": "string", "enum": [ "low", "medium", "high", "variable" ] }, "tempo": { "type": "string", "enum": [ "slow", "medium", "fast", "variable" ] }, "hasVocals": { "type": "boolean" }, "isLoopable": { "type": "boolean" } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "effectCategory", "intensity", "timingUse" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "sound_effect" ] }, "effectCategory": { "type": "string" }, "intensity": { "type": "string", "enum": [ "low", "medium", "high" ] }, "timingUse": { "type": "string", "enum": [ "intro", "impact", "reaction", "transition", "outro" ] } }, "additionalProperties": false } ] } ] }, { "type": "null" } ] }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.assetsListAssets({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.assets_list_assets(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark assets list \\\n --request '{\"path\":{\"teamId\":\"teamId\"}}'" } ], "summary": "List assets", "x-displayName": "List assets" } }, "/v1/teams/{teamId}/assets/{assetId}": { "get": { "tags": [ "Assets" ], "operationId": "assets.getAsset", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "type", "width", "height", "format" ], "properties": { "type": { "type": "string", "enum": [ "image" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "format": { "type": "string" }, "colorSpace": { "type": "string" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "video" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "duration": { "type": "number" }, "codec": { "type": "string" }, "bitrate": { "type": "number" }, "fps": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "audio" ] }, "duration": { "type": "number" }, "sampleRate": { "type": "number" }, "channels": { "type": "number" }, "codec": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "frameCount" ], "properties": { "type": { "type": "string", "enum": [ "gif" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "frameCount": { "type": "number" }, "duration": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "format" ], "properties": { "type": { "type": "string", "enum": [ "document" ] }, "pageCount": { "type": "number" }, "format": { "type": "string" } }, "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "chromaKey", "analysisVersion", "confidence", "chromaKeyProfiles", "subjectAnalysis", "aspectRatioProfiles", "captioning", "audio", "composition" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "green_screen_template" ] }, "chromaKey": { "type": "object", "required": [ "keyColor", "ffmpegSimilarity", "ffmpegBlend", "spillRisk" ], "properties": { "keyColor": { "type": "string", "enum": [ "#00ff00" ] }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" }, "spillRisk": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "additionalProperties": false }, "analysisVersion": { "type": "number" }, "confidence": { "type": "number" }, "chromaKeyProfiles": { "type": "object", "required": [ "baseline", "fallback" ], "properties": { "baseline": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "fallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "confidence": { "type": "number" }, "strongFallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "subjectAnalysis": { "type": "object", "required": [ "sampleCount", "sampleTimestampsSeconds", "representativeBounds", "subjectHeightFraction", "subjectWidthFraction", "centerXFraction", "bottomYFraction", "cropRisk", "faceRegion", "confidence" ], "properties": { "sampleCount": { "type": "number" }, "sampleTimestampsSeconds": { "type": "array", "items": { "type": "number" } }, "representativeBounds": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "defaultSubjectBounds": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "subjectHeightFraction": { "type": "number" }, "subjectWidthFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "bottomYFraction": { "type": "number" }, "cropRisk": { "type": "object", "required": [ "top", "bottom", "left", "right" ], "properties": { "top": { "type": "number" }, "bottom": { "type": "number" }, "left": { "type": "number" }, "right": { "type": "number" } }, "additionalProperties": false }, "defaultFaceRegion": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRange": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRangeDelta": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "additionalProperties": false }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegion": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "confidence": { "type": "number" } }, "additionalProperties": false }, "aspectRatioProfiles": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "captioning": { "type": "object", "required": [ "preferredCaptionZones", "forbiddenCaptionZones", "subjectBoundsByAspectRatio", "faceRegionByAspectRatio", "captionSafeBandsByAspectRatio", "preferredZonesByAspectRatio", "forbiddenZonesByAspectRatio" ], "properties": { "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "16:9": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "1:1": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "4:5": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "preferredZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "forbiddenZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "audio": { "type": "object", "required": [ "hasAudio", "likelyHasMusic", "likelyHasSpeech", "needsMusic" ], "properties": { "hasAudio": { "type": "boolean" }, "likelyHasMusic": { "type": "boolean" }, "likelyHasSpeech": { "type": "boolean" }, "needsMusic": { "type": "boolean" } }, "additionalProperties": false }, "composition": { "type": "object", "required": [ "safeCaptionZones", "captionSafeBandsByAspectRatio", "recommendedBackgroundTags", "recommendedMusicTags", "recommendedSoundEffectTags" ], "properties": { "safeCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "recommendedBackgroundTags": { "type": "array", "items": { "type": "string" } }, "recommendedMusicTags": { "type": "array", "items": { "type": "string" } }, "recommendedSoundEffectTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "aspectRatioCategory" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "background" ] }, "aspectRatioCategory": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5", "other" ] }, "dominantColors": { "type": "array", "items": { "type": "string" } }, "isLoopable": { "type": "boolean" }, "textSafeZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "mood", "energyLevel" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "music" ] }, "mood": { "type": "array", "items": { "type": "string" } }, "energyLevel": { "type": "string", "enum": [ "low", "medium", "high", "variable" ] }, "tempo": { "type": "string", "enum": [ "slow", "medium", "fast", "variable" ] }, "hasVocals": { "type": "boolean" }, "isLoopable": { "type": "boolean" } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "effectCategory", "intensity", "timingUse" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "sound_effect" ] }, "effectCategory": { "type": "string" }, "intensity": { "type": "string", "enum": [ "low", "medium", "high" ] }, "timingUse": { "type": "string", "enum": [ "intro", "impact", "reaction", "transition", "outro" ] } }, "additionalProperties": false } ] } ] }, { "type": "null" } ] }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.assetsGetAsset({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n assetId: process.env.OCTOSPARK_ASSET_ID ?? \"assetId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.assets_get_asset(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n assetId=os.environ.get(\"OCTOSPARK_ASSET_ID\", \"assetId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark assets get \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"assetId\":\"assetId\"}}'" } ], "summary": "Asset", "x-displayName": "Asset" }, "delete": { "tags": [ "Assets" ], "operationId": "assets.softDeleteAsset", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "type", "width", "height", "format" ], "properties": { "type": { "type": "string", "enum": [ "image" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "format": { "type": "string" }, "colorSpace": { "type": "string" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "video" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "duration": { "type": "number" }, "codec": { "type": "string" }, "bitrate": { "type": "number" }, "fps": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "audio" ] }, "duration": { "type": "number" }, "sampleRate": { "type": "number" }, "channels": { "type": "number" }, "codec": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "frameCount" ], "properties": { "type": { "type": "string", "enum": [ "gif" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "frameCount": { "type": "number" }, "duration": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "format" ], "properties": { "type": { "type": "string", "enum": [ "document" ] }, "pageCount": { "type": "number" }, "format": { "type": "string" } }, "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "chromaKey", "analysisVersion", "confidence", "chromaKeyProfiles", "subjectAnalysis", "aspectRatioProfiles", "captioning", "audio", "composition" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "green_screen_template" ] }, "chromaKey": { "type": "object", "required": [ "keyColor", "ffmpegSimilarity", "ffmpegBlend", "spillRisk" ], "properties": { "keyColor": { "type": "string", "enum": [ "#00ff00" ] }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" }, "spillRisk": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "additionalProperties": false }, "analysisVersion": { "type": "number" }, "confidence": { "type": "number" }, "chromaKeyProfiles": { "type": "object", "required": [ "baseline", "fallback" ], "properties": { "baseline": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "fallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "confidence": { "type": "number" }, "strongFallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "subjectAnalysis": { "type": "object", "required": [ "sampleCount", "sampleTimestampsSeconds", "representativeBounds", "subjectHeightFraction", "subjectWidthFraction", "centerXFraction", "bottomYFraction", "cropRisk", "faceRegion", "confidence" ], "properties": { "sampleCount": { "type": "number" }, "sampleTimestampsSeconds": { "type": "array", "items": { "type": "number" } }, "representativeBounds": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "defaultSubjectBounds": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "subjectHeightFraction": { "type": "number" }, "subjectWidthFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "bottomYFraction": { "type": "number" }, "cropRisk": { "type": "object", "required": [ "top", "bottom", "left", "right" ], "properties": { "top": { "type": "number" }, "bottom": { "type": "number" }, "left": { "type": "number" }, "right": { "type": "number" } }, "additionalProperties": false }, "defaultFaceRegion": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRange": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRangeDelta": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "additionalProperties": false }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegion": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "confidence": { "type": "number" } }, "additionalProperties": false }, "aspectRatioProfiles": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "captioning": { "type": "object", "required": [ "preferredCaptionZones", "forbiddenCaptionZones", "subjectBoundsByAspectRatio", "faceRegionByAspectRatio", "captionSafeBandsByAspectRatio", "preferredZonesByAspectRatio", "forbiddenZonesByAspectRatio" ], "properties": { "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "16:9": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "1:1": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "4:5": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "preferredZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "forbiddenZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "audio": { "type": "object", "required": [ "hasAudio", "likelyHasMusic", "likelyHasSpeech", "needsMusic" ], "properties": { "hasAudio": { "type": "boolean" }, "likelyHasMusic": { "type": "boolean" }, "likelyHasSpeech": { "type": "boolean" }, "needsMusic": { "type": "boolean" } }, "additionalProperties": false }, "composition": { "type": "object", "required": [ "safeCaptionZones", "captionSafeBandsByAspectRatio", "recommendedBackgroundTags", "recommendedMusicTags", "recommendedSoundEffectTags" ], "properties": { "safeCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "recommendedBackgroundTags": { "type": "array", "items": { "type": "string" } }, "recommendedMusicTags": { "type": "array", "items": { "type": "string" } }, "recommendedSoundEffectTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "aspectRatioCategory" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "background" ] }, "aspectRatioCategory": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5", "other" ] }, "dominantColors": { "type": "array", "items": { "type": "string" } }, "isLoopable": { "type": "boolean" }, "textSafeZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "mood", "energyLevel" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "music" ] }, "mood": { "type": "array", "items": { "type": "string" } }, "energyLevel": { "type": "string", "enum": [ "low", "medium", "high", "variable" ] }, "tempo": { "type": "string", "enum": [ "slow", "medium", "fast", "variable" ] }, "hasVocals": { "type": "boolean" }, "isLoopable": { "type": "boolean" } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "effectCategory", "intensity", "timingUse" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "sound_effect" ] }, "effectCategory": { "type": "string" }, "intensity": { "type": "string", "enum": [ "low", "medium", "high" ] }, "timingUse": { "type": "string", "enum": [ "intro", "impact", "reaction", "transition", "outro" ] } }, "additionalProperties": false } ] } ] }, { "type": "null" } ] }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.assetsSoftDeleteAsset({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n assetId: process.env.OCTOSPARK_ASSET_ID ?? \"assetId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.assets_soft_delete_asset(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n assetId=os.environ.get(\"OCTOSPARK_ASSET_ID\", \"assetId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark assets delete \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"assetId\":\"assetId\"}}'" } ], "summary": "Soft delete asset", "x-displayName": "Soft delete asset" } }, "/v1/teams/{teamId}/assets/{assetId}/references": { "get": { "tags": [ "Assets" ], "operationId": "assets.getAssetReferences", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "liveScheduled", "draft" ], "properties": { "liveScheduled": { "type": "object", "required": [ "count", "scheduledPostIds" ], "properties": { "count": { "type": "number" }, "scheduledPostIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false }, "draft": { "type": "object", "required": [ "count", "contentItemIds" ], "properties": { "count": { "type": "number" }, "contentItemIds": { "type": "array", "items": { "$ref": "#/components/schemas/UUID" } } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.assetsGetAssetReferences({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n assetId: process.env.OCTOSPARK_ASSET_ID ?? \"assetId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.assets_get_asset_references(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n assetId=os.environ.get(\"OCTOSPARK_ASSET_ID\", \"assetId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark assets get-asset-references \\\n --request '{\"path\":{\"teamId\":\"teamId\",\"assetId\":\"assetId\"}}'" } ], "summary": "Asset references", "x-displayName": "Asset references" } }, "/v1/teams/{teamId}/assets/agentic-search": { "post": { "tags": [ "Assets" ], "operationId": "assets.searchAgenticAssets", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "mode", "total", "data", "costResult", "embeddingStatus" ], "properties": { "mode": { "type": "string", "enum": [ "metadata", "semantic", "hybrid" ] }, "total": { "type": "number" }, "data": { "type": "array", "items": { "type": "object", "required": [ "source", "score", "rankingReasons", "asset", "assetUrl", "thumbnailUrl" ], "properties": { "source": { "type": "string", "enum": [ "team", "seed_library" ] }, "score": { "type": "number" }, "rankingReasons": { "type": "array", "items": { "type": "string" } }, "asset": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "type", "width", "height", "format" ], "properties": { "type": { "type": "string", "enum": [ "image" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "format": { "type": "string" }, "colorSpace": { "type": "string" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "video" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "duration": { "type": "number" }, "codec": { "type": "string" }, "bitrate": { "type": "number" }, "fps": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "audio" ] }, "duration": { "type": "number" }, "sampleRate": { "type": "number" }, "channels": { "type": "number" }, "codec": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "frameCount" ], "properties": { "type": { "type": "string", "enum": [ "gif" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "frameCount": { "type": "number" }, "duration": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "format" ], "properties": { "type": { "type": "string", "enum": [ "document" ] }, "pageCount": { "type": "number" }, "format": { "type": "string" } }, "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "chromaKey", "analysisVersion", "confidence", "chromaKeyProfiles", "subjectAnalysis", "aspectRatioProfiles", "captioning", "audio", "composition" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "green_screen_template" ] }, "chromaKey": { "type": "object", "required": [ "keyColor", "ffmpegSimilarity", "ffmpegBlend", "spillRisk" ], "properties": { "keyColor": { "type": "string", "enum": [ "#00ff00" ] }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" }, "spillRisk": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "additionalProperties": false }, "analysisVersion": { "type": "number" }, "confidence": { "type": "number" }, "chromaKeyProfiles": { "type": "object", "required": [ "baseline", "fallback" ], "properties": { "baseline": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "fallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "confidence": { "type": "number" }, "strongFallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "subjectAnalysis": { "type": "object", "required": [ "sampleCount", "sampleTimestampsSeconds", "representativeBounds", "subjectHeightFraction", "subjectWidthFraction", "centerXFraction", "bottomYFraction", "cropRisk", "faceRegion", "confidence" ], "properties": { "sampleCount": { "type": "number" }, "sampleTimestampsSeconds": { "type": "array", "items": { "type": "number" } }, "representativeBounds": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "defaultSubjectBounds": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "subjectHeightFraction": { "type": "number" }, "subjectWidthFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "bottomYFraction": { "type": "number" }, "cropRisk": { "type": "object", "required": [ "top", "bottom", "left", "right" ], "properties": { "top": { "type": "number" }, "bottom": { "type": "number" }, "left": { "type": "number" }, "right": { "type": "number" } }, "additionalProperties": false }, "defaultFaceRegion": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRange": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRangeDelta": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "additionalProperties": false }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegion": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "confidence": { "type": "number" } }, "additionalProperties": false }, "aspectRatioProfiles": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "captioning": { "type": "object", "required": [ "preferredCaptionZones", "forbiddenCaptionZones", "subjectBoundsByAspectRatio", "faceRegionByAspectRatio", "captionSafeBandsByAspectRatio", "preferredZonesByAspectRatio", "forbiddenZonesByAspectRatio" ], "properties": { "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "16:9": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "1:1": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "4:5": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "preferredZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "forbiddenZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "audio": { "type": "object", "required": [ "hasAudio", "likelyHasMusic", "likelyHasSpeech", "needsMusic" ], "properties": { "hasAudio": { "type": "boolean" }, "likelyHasMusic": { "type": "boolean" }, "likelyHasSpeech": { "type": "boolean" }, "needsMusic": { "type": "boolean" } }, "additionalProperties": false }, "composition": { "type": "object", "required": [ "safeCaptionZones", "captionSafeBandsByAspectRatio", "recommendedBackgroundTags", "recommendedMusicTags", "recommendedSoundEffectTags" ], "properties": { "safeCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "recommendedBackgroundTags": { "type": "array", "items": { "type": "string" } }, "recommendedMusicTags": { "type": "array", "items": { "type": "string" } }, "recommendedSoundEffectTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "aspectRatioCategory" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "background" ] }, "aspectRatioCategory": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5", "other" ] }, "dominantColors": { "type": "array", "items": { "type": "string" } }, "isLoopable": { "type": "boolean" }, "textSafeZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "mood", "energyLevel" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "music" ] }, "mood": { "type": "array", "items": { "type": "string" } }, "energyLevel": { "type": "string", "enum": [ "low", "medium", "high", "variable" ] }, "tempo": { "type": "string", "enum": [ "slow", "medium", "fast", "variable" ] }, "hasVocals": { "type": "boolean" }, "isLoopable": { "type": "boolean" } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "effectCategory", "intensity", "timingUse" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "sound_effect" ] }, "effectCategory": { "type": "string" }, "intensity": { "type": "string", "enum": [ "low", "medium", "high" ] }, "timingUse": { "type": "string", "enum": [ "intro", "impact", "reaction", "transition", "outro" ] } }, "additionalProperties": false } ] } ] }, { "type": "null" } ] }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false }, "assetUrl": { "type": "string" }, "thumbnailUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "costResult": { "type": "object", "required": [ "name", "costInCreditsDecimillicents", "costInDollars", "marginCostInCreditsDecimillicents", "marginCostInDollars" ], "properties": { "name": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "costInCreditsDecimillicents": { "type": "number" }, "costInDollars": { "type": "number" }, "marginCostInCreditsDecimillicents": { "type": "number" }, "marginCostInDollars": { "type": "number" } }, "additionalProperties": false }, "embeddingStatus": { "anyOf": [ { "type": "object", "required": [ "embeddingsReady", "totalAssets", "withEmbeddings", "withoutEmbeddings", "message" ], "properties": { "embeddingsReady": { "type": "boolean" }, "totalAssets": { "type": "number" }, "withEmbeddings": { "type": "number" }, "withoutEmbeddings": { "type": "number" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "query" ], "properties": { "query": { "type": "string", "description": "a string at most 512 character(s) long", "title": "maxLength(512)", "minLength": 1, "maxLength": 512 }, "mode": { "type": "string", "enum": [ "metadata", "semantic", "hybrid" ] }, "limit": { "type": "integer", "description": "a number less than or equal to 50", "title": "lessThanOrEqualTo(50)", "minimum": 1, "maximum": 50 }, "includeSeedLibrary": { "type": "boolean" }, "assetTypes": { "type": "array", "items": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] } }, "assetCategories": { "type": "array", "items": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] } } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.assetsSearchAgenticAssets({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.assets_search_agentic_assets(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark assets semantic-search \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"body\":{}}'" } ], "summary": "Search agentic assets", "x-displayName": "Search agentic assets" } }, "/v1/teams/{teamId}/assets/search": { "get": { "tags": [ "Assets" ], "operationId": "assets.searchAssets", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "query", "in": "query", "schema": { "type": "string", "description": "a string at least 1 character(s) long", "title": "minLength(1)", "minLength": 1 }, "required": true, "description": "a string at least 1 character(s) long" }, { "name": "semantic", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "sortOrder", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "required": false }, { "name": "filter[assetType]", "in": "query", "schema": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "total", "nextCursor", "prevCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "teamId", "originalFilename", "fileSize", "mimeType", "assetType", "assetCategory", "assetTypeData", "storagePath", "thumbnailPath", "aiTitle", "aiDescription", "aiTags", "contentHash", "processingStatus", "processingError", "isDeleted", "deletedAt", "hardDeletedAt", "sharedWithOrg", "displayName", "aspectRatio", "isProcessing", "createdAt", "updatedAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "teamId": { "$ref": "#/components/schemas/UUID" }, "originalFilename": { "type": "string" }, "fileSize": { "type": "number" }, "mimeType": { "type": "string" }, "assetType": { "type": "string", "enum": [ "image", "video", "audio", "gif", "document" ] }, "assetCategory": { "type": "string", "enum": [ "user_upload", "render", "template", "green_screen_template", "sound_effect", "music", "brand_asset", "other" ] }, "assetTypeData": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "required": [ "type", "width", "height", "format" ], "properties": { "type": { "type": "string", "enum": [ "image" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "format": { "type": "string" }, "colorSpace": { "type": "string" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "video" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "duration": { "type": "number" }, "codec": { "type": "string" }, "bitrate": { "type": "number" }, "fps": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "duration", "codec" ], "properties": { "type": { "type": "string", "enum": [ "audio" ] }, "duration": { "type": "number" }, "sampleRate": { "type": "number" }, "channels": { "type": "number" }, "codec": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "width", "height", "frameCount" ], "properties": { "type": { "type": "string", "enum": [ "gif" ] }, "width": { "type": "number" }, "height": { "type": "number" }, "frameCount": { "type": "number" }, "duration": { "type": "number" }, "aspectRatio": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "format" ], "properties": { "type": { "type": "string", "enum": [ "document" ] }, "pageCount": { "type": "number" }, "format": { "type": "string" } }, "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "chromaKey", "analysisVersion", "confidence", "chromaKeyProfiles", "subjectAnalysis", "aspectRatioProfiles", "captioning", "audio", "composition" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "green_screen_template" ] }, "chromaKey": { "type": "object", "required": [ "keyColor", "ffmpegSimilarity", "ffmpegBlend", "spillRisk" ], "properties": { "keyColor": { "type": "string", "enum": [ "#00ff00" ] }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" }, "spillRisk": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "additionalProperties": false }, "analysisVersion": { "type": "number" }, "confidence": { "type": "number" }, "chromaKeyProfiles": { "type": "object", "required": [ "baseline", "fallback" ], "properties": { "baseline": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "fallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false }, "confidence": { "type": "number" }, "strongFallback": { "type": "object", "required": [ "similarity", "blend" ], "properties": { "similarity": { "type": "number" }, "blend": { "type": "number" }, "despillMix": { "type": "number" }, "despillExpand": { "type": "number" }, "confidence": { "type": "number" }, "ffmpegSimilarity": { "type": "number" }, "ffmpegBlend": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "subjectAnalysis": { "type": "object", "required": [ "sampleCount", "sampleTimestampsSeconds", "representativeBounds", "subjectHeightFraction", "subjectWidthFraction", "centerXFraction", "bottomYFraction", "cropRisk", "faceRegion", "confidence" ], "properties": { "sampleCount": { "type": "number" }, "sampleTimestampsSeconds": { "type": "array", "items": { "type": "number" } }, "representativeBounds": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "defaultSubjectBounds": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "subjectHeightFraction": { "type": "number" }, "subjectWidthFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "bottomYFraction": { "type": "number" }, "cropRisk": { "type": "object", "required": [ "top", "bottom", "left", "right" ], "properties": { "top": { "type": "number" }, "bottom": { "type": "number" }, "left": { "type": "number" }, "right": { "type": "number" } }, "additionalProperties": false }, "defaultFaceRegion": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRange": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "motionRangeDelta": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "additionalProperties": false }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegion": { "anyOf": [ { "type": "object", "required": [ "left", "top", "right", "bottom", "widthFraction", "heightFraction", "centerXFraction", "centerYFraction", "bottomYFraction" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" }, "widthFraction": { "type": "number" }, "heightFraction": { "type": "number" }, "centerXFraction": { "type": "number" }, "centerYFraction": { "type": "number" }, "bottomYFraction": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "confidence": { "type": "number" } }, "additionalProperties": false }, "aspectRatioProfiles": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "aspectRatio", "targetForegroundHeightFraction", "minForegroundHeightFraction", "maxForegroundHeightFraction", "targetCenterX", "targetBottomY", "maxCropTopFraction", "maxCropBottomFraction", "maxCropLeftFraction", "maxCropRightFraction", "preferredCaptionZones", "forbiddenCaptionZones" ], "properties": { "aspectRatio": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5" ] }, "targetForegroundHeightFraction": { "type": "number" }, "minForegroundHeightFraction": { "type": "number" }, "maxForegroundHeightFraction": { "type": "number" }, "targetCenterX": { "type": "number" }, "targetBottomY": { "type": "number" }, "maxCropTopFraction": { "type": "number" }, "maxCropBottomFraction": { "type": "number" }, "maxCropLeftFraction": { "type": "number" }, "maxCropRightFraction": { "type": "number" }, "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "captioning": { "type": "object", "required": [ "preferredCaptionZones", "forbiddenCaptionZones", "subjectBoundsByAspectRatio", "faceRegionByAspectRatio", "captionSafeBandsByAspectRatio", "preferredZonesByAspectRatio", "forbiddenZonesByAspectRatio" ], "properties": { "preferredCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbiddenCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "subjectBoundsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "faceRegionByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "left", "top", "right", "bottom" ], "properties": { "left": { "type": "number" }, "top": { "type": "number" }, "right": { "type": "number" }, "bottom": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "16:9": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "1:1": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } }, "4:5": { "type": "array", "items": { "type": "object", "required": [ "xMin", "xMax", "yMin", "yMax" ], "properties": { "zone": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] }, "xMin": { "type": "number" }, "xMax": { "type": "number" }, "yMin": { "type": "number" }, "yMax": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "preferredZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "forbiddenZonesByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "16:9": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "1:1": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "4:5": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "audio": { "type": "object", "required": [ "hasAudio", "likelyHasMusic", "likelyHasSpeech", "needsMusic" ], "properties": { "hasAudio": { "type": "boolean" }, "likelyHasMusic": { "type": "boolean" }, "likelyHasSpeech": { "type": "boolean" }, "needsMusic": { "type": "boolean" } }, "additionalProperties": false }, "composition": { "type": "object", "required": [ "safeCaptionZones", "captionSafeBandsByAspectRatio", "recommendedBackgroundTags", "recommendedMusicTags", "recommendedSoundEffectTags" ], "properties": { "safeCaptionZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "captionSafeBandsByAspectRatio": { "type": "object", "required": [], "properties": { "9:16": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "16:9": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "1:1": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, "4:5": { "type": "object", "required": [ "preferred", "forbidden" ], "properties": { "preferred": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } }, "forbidden": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "recommendedBackgroundTags": { "type": "array", "items": { "type": "string" } }, "recommendedMusicTags": { "type": "array", "items": { "type": "string" } }, "recommendedSoundEffectTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "aspectRatioCategory" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "background" ] }, "aspectRatioCategory": { "type": "string", "enum": [ "9:16", "16:9", "1:1", "4:5", "other" ] }, "dominantColors": { "type": "array", "items": { "type": "string" } }, "isLoopable": { "type": "boolean" }, "textSafeZones": { "type": "array", "items": { "type": "string", "enum": [ "top", "middle", "bottom", "left", "right" ] } } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "mood", "energyLevel" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "music" ] }, "mood": { "type": "array", "items": { "type": "string" } }, "energyLevel": { "type": "string", "enum": [ "low", "medium", "high", "variable" ] }, "tempo": { "type": "string", "enum": [ "slow", "medium", "fast", "variable" ] }, "hasVocals": { "type": "boolean" }, "isLoopable": { "type": "boolean" } }, "additionalProperties": false }, { "type": "object", "required": [ "id", "title", "localPath", "qualityScore", "probe", "source", "systemTemplateLibrary", "provenance", "kind", "effectCategory", "intensity", "timingUse" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "localPath": { "type": "string" }, "thumbnailPath": { "type": "string" }, "qualityScore": { "type": "number" }, "probe": { "type": "object", "required": [ "sizeBytes", "mimeType", "hasVideo", "hasAudio" ], "properties": { "durationSeconds": { "type": "number" }, "sizeBytes": { "type": "number" }, "mimeType": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "fps": { "type": "number" }, "hasVideo": { "type": "boolean" }, "hasAudio": { "type": "boolean" }, "videoCodec": { "type": "string" }, "audioCodec": { "type": "string" }, "bitrate": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "enum": [ "seed_catalog" ] }, "systemTemplateLibrary": { "type": "boolean" }, "provenance": { "type": "object", "required": [ "sourceTags" ], "properties": { "sourceTags": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "kind": { "type": "string", "enum": [ "sound_effect" ] }, "effectCategory": { "type": "string" }, "intensity": { "type": "string", "enum": [ "low", "medium", "high" ] }, "timingUse": { "type": "string", "enum": [ "intro", "impact", "reaction", "transition", "outro" ] } }, "additionalProperties": false } ] } ] }, { "type": "null" } ] }, "storagePath": { "type": "string" }, "thumbnailPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "aiTags": { "type": "array", "items": { "type": "string" } }, "contentHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "processing", "completed", "failed" ] }, "processingError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "deletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hardDeletedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sharedWithOrg": { "type": "boolean" }, "displayName": { "type": "string" }, "aspectRatio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isProcessing": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "additionalProperties": false } }, "total": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.assetsSearchAssets({\n teamId: process.env.OCTOSPARK_TEAM_ID ?? \"teamId\",\n query: {\n \"query\": process.env.OCTOSPARK_QUERY ?? \"query\",\n },\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.assets_search_assets(\n teamId=os.environ.get(\"OCTOSPARK_TEAM_ID\", \"teamId\"),\n query={\n \"query\": os.environ.get(\"OCTOSPARK_QUERY\", \"query\"),\n }\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark assets search \\\n --request '{\"path\":{\"teamId\":\"teamId\"},\"query\":{\"query\":\"query\"}}'" } ], "summary": "Search assets", "x-displayName": "Search assets" } }, "/v1/agent/context": { "get": { "tags": [ "Agent" ], "operationId": "agent.getContext", "parameters": [], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "user", "organizations", "teams", "defaultOrganizationId", "defaultTeamId" ], "properties": { "user": { "type": "object", "required": [ "id", "email" ], "properties": { "id": { "type": "string" }, "email": { "type": "string" } }, "additionalProperties": false }, "organizations": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } }, "teams": { "type": "array", "items": { "type": "object", "required": [ "id", "organizationId", "name" ], "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } }, "defaultOrganizationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "defaultTeamId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.agentGetContext()" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.agent_get_context()" }, { "lang": "CLI", "label": "CLI", "source": "octospark context" } ], "summary": "Get agent context", "x-displayName": "Get agent context" } }, "/v1/billing/{organizationId}/credits": { "get": { "tags": [ "Billing" ], "operationId": "billing.getCreditBalance", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "creditsBalanceDecimillicents", "reservedCreditsDecimillicents", "availableDecimillicents", "isSuspended", "suspendedAt", "paymentGracePeriodEndsAt" ], "properties": { "creditsBalanceDecimillicents": { "type": "number" }, "reservedCreditsDecimillicents": { "type": "number" }, "availableDecimillicents": { "type": "number" }, "isSuspended": { "type": "boolean" }, "suspendedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "paymentGracePeriodEndsAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.billingGetCreditBalance({\n organizationId: process.env.OCTOSPARK_ORGANIZATION_ID ?? \"organizationId\",\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.billing_get_credit_balance(\n organizationId=os.environ.get(\"OCTOSPARK_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark billing balance \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" } ], "summary": "Credit balance", "x-displayName": "Credit balance" } }, "/v1/billing/{organizationId}/credits/history": { "get": { "tags": [ "Billing" ], "operationId": "billing.getCreditHistory", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "cursor", "hasMore" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "entryType", "amountDecimillicents", "reason", "referenceId", "balanceAfter", "createdAt" ], "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "entryType": { "type": "string", "enum": [ "purchase", "usage", "adjustment", "refund", "auto_recharge", "reserve", "release" ] }, "amountDecimillicents": { "type": "number" }, "reason": { "type": "string" }, "referenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "balanceAfter": { "type": "number" }, "createdAt": { "type": "string" } }, "additionalProperties": false } }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hasMore": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.billingGetCreditHistory({\n organizationId: process.env.OCTOSPARK_ORGANIZATION_ID ?? \"organizationId\",\n query: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.billing_get_credit_history(\n organizationId=os.environ.get(\"OCTOSPARK_ORGANIZATION_ID\", \"organizationId\")\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark billing history \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"}}'" } ], "summary": "Credit history", "x-displayName": "Credit history" } }, "/v1/billing/{organizationId}/top-up": { "post": { "tags": [ "Billing" ], "operationId": "billing.createTopUpSession", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/BadRequest" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "402": { "description": "PaymentRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequired" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "NotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "429": { "description": "TooManyRequests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TooManyRequests" } } } }, "500": { "description": "InternalError", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalError" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amountDecimillicents", "successUrl", "cancelUrl" ], "properties": { "amountDecimillicents": { "type": "integer", "description": "a number less than or equal to 5000000000", "title": "lessThanOrEqualTo(5000000000)", "minimum": 100000, "maximum": 5000000000 }, "successUrl": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/", "pattern": "^https?:\\/\\/" }, "cancelUrl": { "type": "string", "description": "a string matching the pattern ^https?:\\/\\/", "pattern": "^https?:\\/\\/" } }, "additionalProperties": false } } }, "required": true }, "x-codeSamples": [ { "lang": "typescript", "label": "TypeScript client", "source": "import { OctosparkClient } from '@octospark/sdk'\n\nconst client = new OctosparkClient({\n token: process.env.OCTOSPARK_TOKEN\n})\n\nconst response = await client.billingCreateTopUpSession({\n organizationId: process.env.OCTOSPARK_ORGANIZATION_ID ?? \"organizationId\",\n body: {},\n})" }, { "lang": "python", "label": "Python client", "source": "import os\nfrom octospark_sdk import OctosparkClient\n\nclient = OctosparkClient(token=os.environ[\"OCTOSPARK_TOKEN\"])\n\nresponse = client.billing_create_top_up_session(\n organizationId=os.environ.get(\"OCTOSPARK_ORGANIZATION_ID\", \"organizationId\"),\n body={}\n)" }, { "lang": "CLI", "label": "CLI", "source": "octospark billing topup \\\n --request '{\"path\":{\"organizationId\":\"organizationId\"},\"body\":{}}'" } ], "summary": "Create top up session", "x-displayName": "Create top up session" } } }, "components": { "schemas": { "HttpApiDecodeError": { "type": "object", "required": [ "issues", "message", "_tag" ], "properties": { "issues": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "HttpApiDecodeError" ] } }, "additionalProperties": false, "description": "The request did not match the expected schema" }, "Issue": { "type": "object", "required": [ "_tag", "path", "message" ], "properties": { "_tag": { "type": "string", "enum": [ "Pointer", "Unexpected", "Missing", "Composite", "Refinement", "Transformation", "Type", "Forbidden" ], "description": "The tag identifying the type of parse issue" }, "path": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyKey" }, "description": "The path to the property where the issue occurred" }, "message": { "type": "string", "description": "A descriptive message explaining the issue" } }, "additionalProperties": false, "description": "Represents an error encountered while parsing a value to match the schema" }, "PropertyKey": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "required": [ "_tag", "key" ], "properties": { "_tag": { "type": "string", "enum": [ "symbol" ] }, "key": { "type": "string" } }, "additionalProperties": false, "description": "an object to be decoded into a globally shared symbol" } ] }, "BadRequest": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "BadRequest" ] } }, "additionalProperties": false }, "Unauthorized": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Unauthorized" ] } }, "additionalProperties": false }, "PaymentRequired": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "PaymentRequired" ] } }, "additionalProperties": false }, "Forbidden": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Forbidden" ] } }, "additionalProperties": false }, "NotFound": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "NotFound" ] } }, "additionalProperties": false }, "Conflict": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "Conflict" ] } }, "additionalProperties": false }, "TooManyRequests": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "TooManyRequests" ] } }, "additionalProperties": false }, "InternalError": { "type": "object", "required": [ "message", "_tag" ], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": [ "InternalError" ] } }, "additionalProperties": false }, "UUID": { "type": "string", "description": "a Universally Unique Identifier", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "Int": { "type": "integer", "description": "an integer", "title": "int" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API key" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Organizations" }, { "name": "Teams" }, { "name": "Social" }, { "name": "Assets" }, { "name": "Agent" }, { "name": "Billing" } ], "servers": [ { "url": "https://api-staging.octospark.ai", "description": "Octospark Staging API" }, { "url": "https://api.octospark.ai", "description": "Octospark Production API" } ], "x-ddd": { "boundedContexts": [ { "name": "IdentityAccess", "owns": [ "Sign up/sign in", "Session token principal" ] }, { "name": "Collaboration", "owns": [ "Organizations", "Teams", "Invitations", "Membership" ] } ], "closedInvariants": [ { "id": "INV-AUTH-001", "rule": "Password must be at least 8 characters." }, { "id": "INV-AUTH-002", "rule": "Forgot-password responses are account-enumeration safe." }, { "id": "INV-ORG-001", "rule": "Organization members are the only actors allowed to manage resources in that organization." }, { "id": "INV-INV-001", "rule": "Invitations can be accepted only when status is pending, not expired, and email matches authenticated principal." }, { "id": "INV-INV-002", "rule": "Invitation list visibility is scoped to invitations whose email matches the authenticated principal." }, { "id": "INV-ARCH-001", "rule": "Domain mutations are accepted only via API/application services; direct UI-to-DB writes are forbidden." } ] } }