排程及發佈
讀取 X 串文及發佈狀態
以 viewer 或以上角色，讀取獲授權串文的各項 canonical Post、發佈結果、完整 expected_versions 及目前允許的 group actions。未知結果須保留原身份及已成功部分；恢復或取消前，必須重新讀取完整版本與 server 決策。此操作為唯讀。
POST /studio-api/x-post-threads/getContract 核對日期: · sha256:304f090f3c014931
概覽
以 viewer 或以上角色，讀取獲授權串文的各項 canonical Post、發佈結果、完整 expected_versions 及目前允許的 group actions。未知結果須保留原身份及已成功部分；恢復或取消前，必須重新讀取完整版本與 server 決策。此操作為唯讀。
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
驗證及權限
憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只會改變可見工具，不會授予權限。
請求欄位
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
id | string父物件內必填 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"workspace_id",
"id"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: canonical per-Post terminal publication outcomes; thread acceptance is not publication.
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
thread | object父物件內必填 | — |
thread.id | string父物件內必填 |
|
thread.workspace_id | string父物件內必填 |
|
thread.social_account_id | string父物件內必填 |
|
thread.idempotency_key | string父物件內必填 |
|
thread.item_count | integer父物件內必填 |
|
thread.created_at | string父物件內必填 | — |
thread.items | array父物件內必填 |
|
thread.items[] | object可選／陣列項目 | — |
thread.items[].item_id | string父物件內必填 |
|
thread.items[].ordinal | integer父物件內必填 |
|
thread.items[].predecessor_post_id | string | null父物件內必填 | — |
thread.items[].predecessor_post_idanyOf 1 | string父物件內必填 |
|
thread.items[].predecessor_post_idanyOf 2 | null父物件內必填 | — |
thread.items[].post | object父物件內必填 | — |
thread.items[].post.id | string父物件內必填 |
|
thread.items[].post.workspace_id | string父物件內必填 |
|
thread.items[].post.social_account_id | string | null父物件內必填 | — |
thread.items[].post.social_account_idanyOf 1 | string父物件內必填 |
|
thread.items[].post.social_account_idanyOf 2 | null父物件內必填 | — |
thread.items[].post.platform | string父物件內必填 |
|
thread.items[].post.destination | object父物件內必填 | — |
thread.items[].post.destination.social_account_id | string | null父物件內必填 | — |
thread.items[].post.destination.social_account_idanyOf 1 | string父物件內必填 |
|
thread.items[].post.destination.social_account_idanyOf 2 | null父物件內必填 | — |
thread.items[].post.destination.platform | string父物件內必填 |
|
thread.items[].post.destination.platform_user_id | string | null父物件內必填 | — |
thread.items[].post.destination.account_label | string | null父物件內必填 | — |
thread.items[].post.caption | string | null父物件內必填 | — |
thread.items[].post.hashtags | array父物件內必填 | — |
thread.items[].post.hashtags[] | string可選／陣列項目 | — |
thread.items[].post.media | array父物件內必填 | — |
thread.items[].post.media[] | object可選／陣列項目 | — |
thread.items[].post.media[].kind | string父物件內必填 |
|
thread.items[].post.media[].url | string父物件內必填 |
|
thread.items[].post.media[].cover_url | string | null可選／陣列項目 | — |
thread.items[].post.media[].cover_urlanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.media[].cover_urlanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.media[].cover_asset_id | integer | null可選／陣列項目 | — |
thread.items[].post.media[].cover_asset_idanyOf 1 | integer可選／陣列項目 |
|
thread.items[].post.media[].cover_asset_idanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.media[].asset_id | integer | null可選／陣列項目 | — |
thread.items[].post.media[].asset_idanyOf 1 | integer可選／陣列項目 |
|
thread.items[].post.media[].asset_idanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.media[].mime_type | string | null可選／陣列項目 | — |
thread.items[].post.media[].mime_typeanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.media[].mime_typeanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.media[].preview_url | string | null可選／陣列項目 | Temporary authorized read URL; keep url as persisted Scheduled Post media identity. — |
thread.items[].post.media[].preview_urlanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.media[].preview_urlanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.media[].cover_preview_url | string | null可選／陣列項目 | Temporary authorized cover read URL; keep cover_url as persisted media identity. — |
thread.items[].post.media[].cover_preview_urlanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.media[].cover_preview_urlanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.media[].preview_expires_at | string | null可選／陣列項目 | — |
thread.items[].post.media[].preview_expires_atanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.media[].preview_expires_atanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.link_url | string | null可選／陣列項目 | — |
thread.items[].post.link_urlanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.link_urlanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.publish_options | object父物件內必填 | — |
thread.items[].post.publish_options.post_type | string可選／陣列項目 |
|
thread.items[].post.publish_options.location_id | string可選／陣列項目 |
|
thread.items[].post.publish_options.share_to_feed | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.collaborators | array可選／陣列項目 |
|
thread.items[].post.publish_options.collaborators[] | string可選／陣列項目 |
|
thread.items[].post.publish_options.first_comment | string可選／陣列項目 |
|
thread.items[].post.publish_options.topic_tag | string可選／陣列項目 |
|
thread.items[].post.publish_options.thumb_offset_ms | integer可選／陣列項目 |
|
thread.items[].post.publish_options.title | string可選／陣列項目 |
|
thread.items[].post.publish_options.youtube_privacy_status | string可選／陣列項目 |
|
thread.items[].post.publish_options.youtube_category_id | string可選／陣列項目 |
|
thread.items[].post.publish_options.youtube_contains_synthetic_media | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.description | string可選／陣列項目 |
|
thread.items[].post.publish_options.category_id | string可選／陣列項目 |
|
thread.items[].post.publish_options.privacy_status | string可選／陣列項目 |
|
thread.items[].post.publish_options.cancellation_mode | string可選／陣列項目 |
|
thread.items[].post.publish_options.tags | array可選／陣列項目 | — |
thread.items[].post.publish_options.tags[] | string可選／陣列項目 | — |
thread.items[].post.publish_options.default_language | string可選／陣列項目 | — |
thread.items[].post.publish_options.localizations | object可選／陣列項目 |
|
thread.items[].post.publish_options.localizations.* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.license | string可選／陣列項目 |
|
thread.items[].post.publish_options.embeddable | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.public_stats_viewable | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.self_declared_made_for_kids | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.contains_synthetic_media | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.has_paid_product_placement | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.recording_date | string可選／陣列項目 | — |
thread.items[].post.publish_options.notify_subscribers | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.thumbnail_asset_id | integer可選／陣列項目 |
|
thread.items[].post.publish_options.surface_expectation | string可選／陣列項目 |
|
thread.items[].post.publish_options.brand_partner | object可選／陣列項目 |
|
thread.items[].post.publish_options.brand_partner.* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.cover_asset_id | integer可選／陣列項目 |
|
thread.items[].post.publish_options.audio_name | string可選／陣列項目 | — |
thread.items[].post.publish_options.trial_params | object可選／陣列項目 |
|
thread.items[].post.publish_options.trial_params.* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.is_ai_generated | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.branded_content_sponsor_ids | array可選／陣列項目 | — |
thread.items[].post.publish_options.branded_content_sponsor_ids[] | string可選／陣列項目 | — |
thread.items[].post.publish_options.is_paid_partnership | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.media_options | array可選／陣列項目 | — |
thread.items[].post.publish_options.media_options[] | object可選／陣列項目 |
|
thread.items[].post.publish_options.media_options[].* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.reply_to_id | string可選／陣列項目 | — |
thread.items[].post.publish_options.quote_post_id | string可選／陣列項目 | — |
thread.items[].post.publish_options.repost_target_id | string可選／陣列項目 | — |
thread.items[].post.publish_options.reply_control | string可選／陣列項目 | — |
thread.items[].post.publish_options.enable_reply_approvals | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.link_attachment | string可選／陣列項目 |
|
thread.items[].post.publish_options.poll_attachment | object可選／陣列項目 |
|
thread.items[].post.publish_options.poll_attachment.* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.gif_attachment | object可選／陣列項目 |
|
thread.items[].post.publish_options.gif_attachment.* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.text_attachment | object可選／陣列項目 |
|
thread.items[].post.publish_options.text_attachment.* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.text_entities | array可選／陣列項目 | — |
thread.items[].post.publish_options.text_entities[] | object可選／陣列項目 |
|
thread.items[].post.publish_options.text_entities[].* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.is_spoiler_media | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.is_ghost_post | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.allowlisted_country_codes | array可選／陣列項目 | — |
thread.items[].post.publish_options.allowlisted_country_codes[] | string可選／陣列項目 | — |
thread.items[].post.publish_options.crossreshare_to_ig | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.crossreshare_to_ig_dark_mode | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.auto_publish_text | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.publication_mode | string可選／陣列項目 |
|
thread.items[].post.publish_options.backdated_time | number可選／陣列項目 | — |
thread.items[].post.publish_options.backdated_time_granularity | string可選／陣列項目 |
|
thread.items[].post.publish_options.place | string可選／陣列項目 | — |
thread.items[].post.publish_options.feed_targeting | object可選／陣列項目 |
|
thread.items[].post.publish_options.feed_targeting.* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.targeting | object可選／陣列項目 |
|
thread.items[].post.publish_options.targeting.* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.child_attachments | array可選／陣列項目 | — |
thread.items[].post.publish_options.child_attachments[] | object可選／陣列項目 |
|
thread.items[].post.publish_options.child_attachments[].* | any JSON value可選／陣列項目 | — |
thread.items[].post.publish_options.multi_share_end_card | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.multi_share_optimized | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.unpublished_content_type | string可選／陣列項目 | — |
thread.items[].post.publish_options.no_story | boolean可選／陣列項目 | — |
thread.items[].post.publish_options.crossposted_video_id | string可選／陣列項目 | — |
thread.items[].post.publish_options.spherical | boolean可選／陣列項目 | — |
thread.items[].post.scheduled_at | string父物件內必填 | — |
thread.items[].post.display_timezone | string父物件內必填 |
|
thread.items[].post.local_scheduled_at | string | null可選／陣列項目 | — |
thread.items[].post.local_scheduled_atanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.local_scheduled_atanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.schedule_timezone | string | null可選／陣列項目 | — |
thread.items[].post.schedule_timezoneanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.schedule_timezoneanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.schedule_dst_disambiguation | string | null可選／陣列項目 | — |
thread.items[].post.schedule_dst_disambiguationanyOf 1 | string可選／陣列項目 |
|
thread.items[].post.schedule_dst_disambiguationanyOf 2 | null可選／陣列項目 | — |
thread.items[].post.schedule_intent_state | string可選／陣列項目 |
|
thread.items[].post.expires_at | string | null父物件內必填 | — |
thread.items[].post.status | string父物件內必填 |
|
thread.items[].post.version | integer父物件內必填 |
|
thread.items[].post.automatic_retry_enabled | boolean父物件內必填 | — |
thread.items[].post.delete_requested_at | string | null父物件內必填 | — |
thread.items[].post.published_at | string | null父物件內必填 | — |
thread.items[].post.deleted_at | string | null父物件內必填 | — |
thread.items[].post.provider_post_id | string | null父物件內必填 | — |
thread.items[].post.permalink | string | null父物件內必填 | — |
thread.items[].post.permalinkanyOf 1 | string父物件內必填 |
|
thread.items[].post.permalinkanyOf 2 | null父物件內必填 | — |
thread.items[].post.created_at | string父物件內必填 | — |
thread.items[].post.updated_at | string父物件內必填 | — |
thread.items[].post.project_id | string | null父物件內必填 | — |
thread.items[].post.project_idanyOf 1 | string父物件內必填 |
|
thread.items[].post.project_idanyOf 2 | null父物件內必填 | — |
thread.items[].post.batch_id | string | null父物件內必填 | — |
thread.items[].post.batch_idanyOf 1 | string父物件內必填 |
|
thread.items[].post.batch_idanyOf 2 | null父物件內必填 | — |
thread.items[].post.source_ref | object | null父物件內必填 | — |
thread.items[].post.source_refanyOf 1 | object父物件內必填 |
|
thread.items[].post.source_ref.*anyOf 1 | any JSON value可選／陣列項目 | — |
thread.items[].post.source_refanyOf 2 | null父物件內必填 | — |
thread.items[].retry_allowed | boolean父物件內必填 | — |
thread.expected_versions | object父物件內必填 |
|
thread.expected_versions.* | integer可選／陣列項目 |
|
thread.actions | array父物件內必填 |
|
thread.actions[] | object可選／陣列項目 | — |
thread.actions[].action | string父物件內必填 |
|
thread.actions[].allowed | boolean父物件內必填 | — |
thread.actions[].reason_code | string父物件內必填 |
|
thread.actions[].message | string父物件內必填 | — |
deduped | boolean可選／陣列項目 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"thread": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"social_account_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"item_count": {
"type": "integer",
"minimum": 2,
"maximum": 25
},
"created_at": {
"type": "string"
},
"items": {
"minItems": 2,
"maxItems": 25,
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"ordinal": {
"type": "integer",
"minimum": 1,
"maximum": 25
},
"predecessor_post_id": {
"anyOf": [
{
"type": "string",
"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}$"
},
{
"type": "null"
}
]
},
"post": {
"type": "object",
"properties": {
"id": {
"type": "string",
"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}$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"social_account_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"instagram",
"threads",
"facebook",
"youtube",
"x"
]
},
"destination": {
"type": "object",
"properties": {
"social_account_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"platform": {
"type": "string",
"enum": [
"instagram",
"threads",
"facebook",
"youtube",
"x"
]
},
"platform_user_id": {
"type": [
"string",
"null"
]
},
"account_label": {
"type": [
"string",
"null"
]
}
},
"required": [
"social_account_id",
"platform",
"platform_user_id",
"account_label"
]
},
"caption": {
"type": [
"string",
"null"
]
},
"hashtags": {
"type": "array",
"items": {
"type": "string"
}
},
"media": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"image",
"video"
]
},
"url": {
"type": "string",
"format": "uri"
},
"cover_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cover_asset_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"asset_id": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"mime_type": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 160
},
{
"type": "null"
}
]
},
"preview_url": {
"description": "Temporary authorized read URL; keep url as persisted Scheduled Post media identity.",
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"cover_preview_url": {
"description": "Temporary authorized cover read URL; keep cover_url as persisted media identity.",
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"preview_expires_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"url"
]
}
},
"link_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"publish_options": {
"type": "object",
"properties": {
"post_type": {
"type": "string",
"enum": [
"TEXT",
"LINK",
"IMAGE",
"MULTI_IMAGE",
"VIDEO",
"CAROUSEL",
"REELS",
"STORY_IMAGE",
"STORY_VIDEO",
"REPOST",
"SHORT"
]
},
"location_id": {
"type": "string",
"minLength": 1
},
"share_to_feed": {
"type": "boolean"
},
"collaborators": {
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"first_comment": {
"type": "string",
"minLength": 1,
"maxLength": 2200
},
"topic_tag": {
"type": "string",
"minLength": 1
},
"thumb_offset_ms": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"title": {
"type": "string",
"maxLength": 255
},
"youtube_privacy_status": {
"type": "string",
"enum": [
"private",
"unlisted",
"public"
]
},
"youtube_category_id": {
"type": "string",
"pattern": "^\\d+$"
},
"youtube_contains_synthetic_media": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 5000
},
"category_id": {
"type": "string",
"pattern": "^\\d+$"
},
"privacy_status": {
"type": "string",
"enum": [
"private",
"unlisted",
"public"
]
},
"cancellation_mode": {
"type": "string",
"enum": [
"DELETE",
"UNSCHEDULE_KEEP_PRIVATE"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"default_language": {
"type": "string"
},
"localizations": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"license": {
"type": "string",
"enum": [
"youtube",
"creativeCommon"
]
},
"embeddable": {
"type": "boolean"
},
"public_stats_viewable": {
"type": "boolean"
},
"self_declared_made_for_kids": {
"type": "boolean"
},
"contains_synthetic_media": {
"type": "boolean"
},
"has_paid_product_placement": {
"type": "boolean"
},
"recording_date": {
"type": "string"
},
"notify_subscribers": {
"type": "boolean"
},
"thumbnail_asset_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"surface_expectation": {
"type": "string",
"const": "SHORT"
},
"brand_partner": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"cover_asset_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"audio_name": {
"type": "string"
},
"trial_params": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"is_ai_generated": {
"type": "boolean"
},
"branded_content_sponsor_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"is_paid_partnership": {
"type": "boolean"
},
"media_options": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"reply_to_id": {
"type": "string"
},
"quote_post_id": {
"type": "string"
},
"repost_target_id": {
"type": "string"
},
"reply_control": {
"type": "string"
},
"enable_reply_approvals": {
"type": "boolean"
},
"link_attachment": {
"type": "string",
"format": "uri"
},
"poll_attachment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"gif_attachment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"text_attachment": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"text_entities": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"is_spoiler_media": {
"type": "boolean"
},
"is_ghost_post": {
"type": "boolean"
},
"allowlisted_country_codes": {
"type": "array",
"items": {
"type": "string"
}
},
"crossreshare_to_ig": {
"type": "boolean"
},
"crossreshare_to_ig_dark_mode": {
"type": "boolean"
},
"auto_publish_text": {
"type": "boolean"
},
"publication_mode": {
"type": "string",
"enum": [
"PUBLISH",
"DRAFT"
]
},
"backdated_time": {
"type": "number"
},
"backdated_time_granularity": {
"type": "string",
"enum": [
"year",
"month",
"day",
"hour",
"minute"
]
},
"place": {
"type": "string"
},
"feed_targeting": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"targeting": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"child_attachments": {
"type": "array",
"items": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"multi_share_end_card": {
"type": "boolean"
},
"multi_share_optimized": {
"type": "boolean"
},
"unpublished_content_type": {
"type": "string"
},
"no_story": {
"type": "boolean"
},
"crossposted_video_id": {
"type": "string"
},
"spherical": {
"type": "boolean"
}
}
},
"scheduled_at": {
"type": "string"
},
"display_timezone": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"local_scheduled_at": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
},
{
"type": "null"
}
]
},
"schedule_timezone": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"schedule_dst_disambiguation": {
"anyOf": [
{
"type": "string",
"enum": [
"exact",
"earlier",
"later"
]
},
{
"type": "null"
}
]
},
"schedule_intent_state": {
"type": "string",
"enum": [
"verified",
"legacy_unverified"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"scheduled",
"publishing",
"published",
"failed",
"expired",
"needs_reschedule",
"cancelled",
"deleted"
]
},
"version": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"automatic_retry_enabled": {
"type": "boolean"
},
"delete_requested_at": {
"type": [
"string",
"null"
]
},
"published_at": {
"type": [
"string",
"null"
]
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"provider_post_id": {
"type": [
"string",
"null"
]
},
"permalink": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"project_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"batch_id": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"source_ref": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspace_id",
"social_account_id",
"platform",
"destination",
"caption",
"hashtags",
"media",
"publish_options",
"scheduled_at",
"display_timezone",
"expires_at",
"status",
"version",
"automatic_retry_enabled",
"delete_requested_at",
"published_at",
"deleted_at",
"provider_post_id",
"permalink",
"created_at",
"updated_at",
"project_id",
"batch_id",
"source_ref"
]
},
"retry_allowed": {
"type": "boolean"
}
},
"required": [
"item_id",
"ordinal",
"predecessor_post_id",
"post",
"retry_allowed"
]
}
},
"expected_versions": {
"type": "object",
"propertyNames": {
"type": "string",
"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}$"
},
"additionalProperties": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"actions": {
"minItems": 2,
"maxItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"resume",
"cancel"
]
},
"allowed": {
"type": "boolean"
},
"reason_code": {
"type": "string",
"enum": [
"allowed",
"no_failed_items",
"resolution_required",
"retry_unavailable",
"terminal_state"
]
},
"message": {
"type": "string"
}
},
"required": [
"action",
"allowed",
"reason_code",
"message"
]
}
}
},
"required": [
"id",
"workspace_id",
"social_account_id",
"idempotency_key",
"item_count",
"created_at",
"items",
"expected_versions",
"actions"
]
},
"deduped": {
"type": "boolean"
}
},
"required": [
"thread"
]
}錯誤及安全重試
請檢查 HTTP 狀態及實際回應格式。400 驗證錯誤可能回傳 ZodError；handler 錯誤可能採用 error／message／code envelope。請保留可用的 request_id 或 x-request-id，避免記錄憑證。遇到 401／403 時，須先修正存取問題；429 須遵守 Retry-After。寫入結果未明或回傳 5xx 時，請先讀取原有結果，再決定是否重試。只有操作支援時才可重用 idempotency key；並無通用重試或 exactly-once 保證。
問題排解指南範例
以下虛構值已按 contract 驗證，並非真實帳戶 ID、憑證或發佈紀錄。請以已授權範圍回傳的 ID、已準備完成的素材及已審核排程取代，並在寫入前核對平台資格。此頁不會呼叫 API。
在伺服器環境設定 SOSOAPI_ACCESS_TOKEN，使用此操作接受的憑證。請勿將憑證放入瀏覽器程式。一般 AI Agent 建議透過 sosoapi auth login 使用瀏覽器 OAuth，由 CLI 管理憑證更新。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "88888888-8888-4888-8888-888888888888"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/x-post-threads/get" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/x-post-threads/get", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "88888888-8888-4888-8888-888888888888"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /studio-api/x-post-threads/get < request.json虛構回應範例
{
"thread": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "88888888-8888-4888-8888-888888888888",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"idempotency_key": "example-x-thread-0001",
"item_count": 2,
"created_at": "2099-01-15T08:00:00Z",
"items": [
{
"item_id": "99999999-9999-4999-8999-999999999991",
"ordinal": 1,
"predecessor_post_id": null,
"retry_allowed": true,
"post": {
"id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa1",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"platform": "x",
"destination": {
"social_account_id": "22222222-2222-4222-8222-222222222222",
"platform": "x",
"platform_user_id": "fictional-x-account",
"account_label": "Fictional X account"
},
"caption": "A fictional two-part announcement.",
"hashtags": [],
"media": [],
"publish_options": {
"post_type": "TEXT"
},
"scheduled_at": "2099-01-15T09:00:00Z",
"display_timezone": "UTC",
"expires_at": null,
"status": "failed",
"version": 2,
"automatic_retry_enabled": false,
"delete_requested_at": null,
"published_at": null,
"deleted_at": null,
"provider_post_id": null,
"permalink": null,
"project_id": null,
"batch_id": null,
"source_ref": null,
"created_at": "2099-01-15T08:00:00Z",
"updated_at": "2099-01-15T08:30:00Z"
}
},
{
"item_id": "99999999-9999-4999-8999-999999999992",
"ordinal": 2,
"predecessor_post_id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa1",
"retry_allowed": true,
"post": {
"id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa2",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "22222222-2222-4222-8222-222222222222",
"platform": "x",
"destination": {
"social_account_id": "22222222-2222-4222-8222-222222222222",
"platform": "x",
"platform_user_id": "fictional-x-account",
"account_label": "Fictional X account"
},
"caption": "The second part of this fictional announcement.",
"hashtags": [],
"media": [],
"publish_options": {
"post_type": "TEXT"
},
"scheduled_at": "2099-01-15T09:00:00Z",
"display_timezone": "UTC",
"expires_at": null,
"status": "failed",
"version": 2,
"automatic_retry_enabled": false,
"delete_requested_at": null,
"published_at": null,
"deleted_at": null,
"provider_post_id": null,
"permalink": null,
"project_id": null,
"batch_id": null,
"source_ref": null,
"created_at": "2099-01-15T08:00:00Z",
"updated_at": "2099-01-15T08:30:00Z"
}
}
],
"expected_versions": {
"aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa1": 2,
"aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaa2": 2
},
"actions": [
{
"action": "resume",
"allowed": true,
"reason_code": "allowed",
"message": "This fictional preflight failure is safe to resume."
},
{
"action": "cancel",
"allowed": true,
"reason_code": "allowed",
"message": "Cancel the unpublished items in this fictional thread."
}
]
}
}