API संदर्भ
API संस्करण 2026-11-09 · OpenAPI 3.1 YAML डाउनलोड करें
ऑथेंटिकेशन वर्कस्पेस-स्कोप्ड प्रोडक्ट की का उपयोग करता है: Authorization: Bearer pk_v1_…। कियाँ स्पष्ट स्कोप और वैकल्पिक अकाउंट एलाउलिस्ट रखती हैं; वे कभी दूसरी कियाँ नहीं बना सकतीं या बिलिंग नहीं बदल सकतीं।
सभी म्यूटेशन को Idempotency-Key हेडर चाहिए; एडिट और शेड्यूलिंग को expectedVersion भी चाहिए। पब्लिश और शेड्यूल प्रति गंतव्य एक डिलीवरी ID के साथ 202 Accepted लौटाते हैं: 202 कभी भी कुछ प्रकाशित होने का दावा नहीं है। परिणाम GET /posts/{id}, ग्राहक वेबहुक, या बैकऑफ़ के साथ बाउंडेड पोलिंग से सत्यापित करें।
एरर कॉन्ट्रैक्ट v1 के नॉर्मलाइज़्ड एनवेलप का उपयोग करते हैं: code, सुरक्षित message, fieldErrors, destinationErrors, retryable, retryAfterSeconds और requestId। जानबूझकर कोई पोस्टिंग-क्रेडिट या कोटा एरर कोड नहीं है।
प्रमाणीकरण
कार्यस्थान उत्पाद कुंजी "Authorization: Bearer pk_v1_…" के रूप में भेजें। हर संचालन के आवश्यक दायरे दिए हैं। प्रमाणीकरण और अनुमतियाँ देखें।
GET /capabilities
अनुमत गंतव्यों के लिए पात्र फ़ॉर्मैट और विकल्प
स्कोप accounts:read चाहिए।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"accounts"
],
"summary": "अनुमत गंतव्यों के लिए पात्र फ़ॉर्मैट और विकल्प",
"description": "स्कोप `accounts:read` चाहिए।",
"responses": {
"200": {
"description": "Capability list",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"capabilities",
"requestId"
],
"properties": {
"capabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Capability"
}
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /accounts
इस की को दिखने वाले गंतव्य अकाउंट सूचीबद्ध करें
की की अकाउंट एलाउलिस्ट का सम्मान करता है। स्कोप accounts:read चाहिए।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"accounts"
],
"summary": "इस की को दिखने वाले गंतव्य अकाउंट सूचीबद्ध करें",
"description": "की की अकाउंट एलाउलिस्ट का सम्मान करता है। स्कोप `accounts:read` चाहिए।",
"parameters": [
{
"$ref": "#/components/parameters/cursor"
},
{
"$ref": "#/components/parameters/limit"
}
],
"responses": {
"200": {
"description": "Account page",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"accounts",
"requestId"
],
"properties": {
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Account"
}
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /accounts/{id}/tiktok/settings
अनुमत कनेक्टेड अकाउंट के लिए सत्यापित TikTok क्रिएटर सेटिंग्स पढ़ें
accounts:read और की की अकाउंट एलाउलिस्ट चाहिए। यह रीड कभी भी मानवीय प्रकाशन सहमति नहीं देता।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"accounts"
],
"summary": "अनुमत कनेक्टेड अकाउंट के लिए सत्यापित TikTok क्रिएटर सेटिंग्स पढ़ें",
"description": "accounts:read और की की अकाउंट एलाउलिस्ट चाहिए। यह रीड कभी भी मानवीय प्रकाशन सहमति नहीं देता।",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Current typed creator settings; a person must confirm choices in the composer",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"settings",
"humanConfirmationRequired",
"requestId"
],
"properties": {
"settings": {
"$ref": "#/components/schemas/TikTokCreatorSettings"
},
"humanConfirmationRequired": {
"type": "boolean",
"const": true
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /media/upload-intents
बाइट रिज़र्व करें और डायरेक्ट अपलोड निर्देश लौटाएँ
स्कोप media:write और एक Idempotency-Key चाहिए। बाइट रिटर्न किए निर्देशों का उपयोग करके प्राइवेट ऑब्जेक्ट स्टोरेज में सीधे अपलोड होते हैं; वे इस API से कभी नहीं गुजरते। कोई स्थायी सार्वजनिक मीडिया URL मौजूद नहीं है।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"media"
],
"summary": "बाइट रिज़र्व करें और डायरेक्ट अपलोड निर्देश लौटाएँ",
"description": "स्कोप `media:write` और एक Idempotency-Key चाहिए। बाइट रिटर्न किए निर्देशों का उपयोग करके प्राइवेट ऑब्जेक्ट स्टोरेज में सीधे अपलोड होते हैं; वे इस API से कभी नहीं गुजरते। कोई स्थायी सार्वजनिक मीडिया URL मौजूद नहीं है।\n",
"parameters": [
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadIntentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Upload instructions created",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadIntentResponse"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /media/{id}
मीडिया स्थिति और एक्सपायरी (कोई स्थायी सार्वजनिक URL नहीं)
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"media"
],
"summary": "मीडिया स्थिति और एक्सपायरी (कोई स्थायी सार्वजनिक URL नहीं)",
"parameters": [
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"200": {
"description": "Media status",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"media",
"requestId"
],
"properties": {
"media": {
"$ref": "#/components/schemas/MediaStatus"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /media/{id}/upload-parts
मौजूदा अपलोड सेशन में एक से 64 multipart PUT URL रिफ़्रेश करें
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"media"
],
"summary": "मौजूदा अपलोड सेशन में एक से 64 multipart PUT URL रिफ़्रेश करें",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"fromPart",
"toPart"
],
"properties": {
"fromPart": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"toPart": {
"type": "integer",
"minimum": 1,
"maximum": 10000
}
}
}
}
}
},
"responses": {
"200": {
"description": "Fresh upload URLs; toPart must be at least fromPart and at most fromPart + 63",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"sessionId",
"parts",
"requestId"
],
"properties": {
"sessionId": {
"type": "string",
"format": "uuid"
},
"requestId": {
"type": "string"
},
"parts": {
"type": "array",
"items": {
"type": "object",
"required": [
"partNumber",
"url",
"expiresAt"
],
"properties": {
"partNumber": {
"type": "integer"
},
"url": {
"type": "string",
"format": "uri"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /media/{id}/abandon
अधूरा अपलोड त्यागें और उसका स्टोरेज रिज़र्वेशन जारी करें
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"media"
],
"summary": "अधूरा अपलोड त्यागें और उसका स्टोरेज रिज़र्वेशन जारी करें",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "Abandoned; failed external cleanup remains durably queued",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"abandoned",
"requestId"
],
"properties": {
"abandoned": {
"type": "boolean",
"const": true
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /media/{id}/finalize
अपलोड किया ऑब्जेक्ट सत्यापित करें और उसे उपयोग योग्य बनाएँ
स्कोप media:write और एक Idempotency-Key चाहिए। सर्वर अपरिवर्तनीय FINAL कॉपी के विरुद्ध size/MIME और बाउंडेड सिग्नेचर सत्यापित करता है; बाइट रिज़र्वेशन बिल्कुल एक बार सेटल होते हैं। केवल सेशन पहचान भेजें (लागू होने पर multipart पार्ट रसीदें सहित): सर्वर सारा मेटाडेटा स्वयं देखता है।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"media"
],
"summary": "अपलोड किया ऑब्जेक्ट सत्यापित करें और उसे उपयोग योग्य बनाएँ",
"description": "स्कोप `media:write` और एक Idempotency-Key चाहिए। सर्वर अपरिवर्तनीय FINAL कॉपी के विरुद्ध size/MIME और बाउंडेड सिग्नेचर सत्यापित करता है; बाइट रिज़र्वेशन बिल्कुल एक बार सेटल होते हैं। केवल सेशन पहचान भेजें (लागू होने पर multipart पार्ट रसीदें सहित): सर्वर सारा मेटाडेटा स्वयं देखता है।\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FinalizeRequest"
}
}
}
},
"responses": {
"200": {
"description": "Finalized",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"media",
"requestId"
],
"properties": {
"media": {
"$ref": "#/components/schemas/FinalizeResult"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /posts
ड्राफ़्ट बनाएँ
स्कोप posts:write और एक Idempotency-Key चाहिए। बॉडी कॉन्ट्रैक्ट v1 के सख्त DraftInputSchema से पार्स होती हैं; डुप्लिकेट गंतव्य अकाउंट अस्वीकार किए जाते हैं। सेविंग उदार है: प्रकाशन से पहले सत्यापित करें।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"posts"
],
"summary": "ड्राफ़्ट बनाएँ",
"description": "स्कोप `posts:write` और एक Idempotency-Key चाहिए। बॉडी कॉन्ट्रैक्ट v1 के सख्त DraftInputSchema से पार्स होती हैं; डुप्लिकेट गंतव्य अकाउंट अस्वीकार किए जाते हैं। सेविंग उदार है: प्रकाशन से पहले सत्यापित करें।\n",
"parameters": [
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftInput"
}
}
}
},
"responses": {
"201": {
"description": "Draft created",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"post",
"requestId"
],
"properties": {
"post": {
"$ref": "#/components/schemas/DraftSaveResult"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /posts
पोस्ट्स सूचीबद्ध करें
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"posts"
],
"summary": "पोस्ट्स सूचीबद्ध करें",
"parameters": [
{
"$ref": "#/components/parameters/cursor"
},
{
"$ref": "#/components/parameters/limit"
},
{
"name": "state",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Post page",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"posts",
"requestId"
],
"properties": {
"posts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostListItem"
}
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /posts/{id}
पोस्ट एग्रीगेट और प्रति-गंतव्य स्थिति
"प्रोवाइडर द्वारा स्वीकृत" का अर्थ "प्रकाशित" नहीं है। नेटिव लिंक केवल पुष्ट रसीद के बाद दिखते हैं; अनुपलब्ध पर्मालिंक विफलता का प्रमाण नहीं है।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"posts"
],
"summary": "पोस्ट एग्रीगेट और प्रति-गंतव्य स्थिति",
"description": "\"प्रोवाइडर द्वारा स्वीकृत\" का अर्थ \"प्रकाशित\" नहीं है। नेटिव लिंक केवल पुष्ट रसीद के बाद दिखते हैं; अनुपलब्ध पर्मालिंक विफलता का प्रमाण नहीं है।\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
}
],
"responses": {
"200": {
"description": "Post status",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"post",
"requestId"
],
"properties": {
"post": {
"$ref": "#/components/schemas/PostStatus"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}PATCH /posts/{id}
ड्राफ़्ट एडिट करें (वर्ज़न-जाँचित)
Idempotency-Key और expectedVersion चाहिए। पुराना वर्ज़न 409 revision_conflict लौटाता है, जिसमें वर्तमान वर्ज़न error.details.currentVersion में होता है।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"posts"
],
"summary": "ड्राफ़्ट एडिट करें (वर्ज़न-जाँचित)",
"description": "Idempotency-Key और expectedVersion चाहिए। पुराना वर्ज़न 409 revision_conflict लौटाता है, जिसमें वर्तमान वर्ज़न `error.details.currentVersion` में होता है।\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftUpdateInput"
}
}
}
},
"responses": {
"200": {
"description": "Updated draft",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"post",
"requestId"
],
"properties": {
"post": {
"$ref": "#/components/schemas/DraftSaveResult"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /posts/{id}/validate
संरचित प्रति-गंतव्य वैलिडेशन (गैर-म्यूटिंग)
गंतव्यों में समस्याएँ होने पर validation.valid=false के साथ 200 लौटाता है (कंटेंट समस्याओं के लिए कभी एरर स्टेटस नहीं)।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"posts"
],
"summary": "संरचित प्रति-गंतव्य वैलिडेशन (गैर-म्यूटिंग)",
"description": "गंतव्यों में समस्याएँ होने पर `validation.valid=false` के साथ 200 लौटाता है (कंटेंट समस्याओं के लिए कभी एरर स्टेटस नहीं)।\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedVersion": {
"type": "integer",
"minimum": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "Validation result",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"validation",
"requestId"
],
"properties": {
"validation": {
"$ref": "#/components/schemas/ValidationResult"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /posts/{id}/publish
अभी प्रकाशित करें (202)
स्कोप posts:publish और एक Idempotency-Key चाहिए। वैकल्पिक expectedVersion एडिटिंग जैसी ही ऑप्टिमिस्टिक-कॉनकरेंसी गारंटी लागू करता है। प्रति गंतव्य एक डिलीवरी ID लौटाता है; कभी Published का दावा नहीं करता।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"posts"
],
"summary": "अभी प्रकाशित करें (202)",
"description": "स्कोप `posts:publish` और एक Idempotency-Key चाहिए। वैकल्पिक `expectedVersion` एडिटिंग जैसी ही ऑप्टिमिस्टिक-कॉनकरेंसी गारंटी लागू करता है। प्रति गंतव्य एक डिलीवरी ID लौटाता है; कभी Published का दावा नहीं करता।\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"expectedVersion": {
"type": "integer",
"minimum": 1
}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted for dispatch",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptedOperation"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /posts/{id}/schedule
फ़्रोज़न रिविज़न शेड्यूल करें (202)
स्कोप posts:publish और Idempotency-Key तथा expectedVersion चाहिए। पूरे बैच के लिए एक क्षण; भविष्य का और 90-दिवसीय क्षितिज के भीतर होना चाहिए (साझा सेवा द्वारा लागू)। V1 में revisionId null होना चाहिए: मनमाना रिविज़न चुनना समर्थित नहीं और अस्वीकार किया जाता है।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"posts"
],
"summary": "फ़्रोज़न रिविज़न शेड्यूल करें (202)",
"description": "स्कोप `posts:publish` और Idempotency-Key तथा expectedVersion चाहिए। पूरे बैच के लिए एक क्षण; भविष्य का और 90-दिवसीय क्षितिज के भीतर होना चाहिए (साझा सेवा द्वारा लागू)। V1 में `revisionId` null होना चाहिए: मनमाना रिविज़न चुनना समर्थित नहीं और अस्वीकार किया जाता है।\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleRequest"
}
}
}
},
"responses": {
"202": {
"description": "Scheduled",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptedOperation"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /deliveries/{id}/cancel
सुरक्षित रूप से अनक्लेम्ड होने पर एक गंतव्य जॉब रद्द करें
स्कोप posts:publish और Idempotency-Key चाहिए। पहले से सबमिट की गई डिलीवरी वास्तविक स्थिति के साथ 409 too_late_to_cancel लौटाती हैं।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"deliveries"
],
"summary": "सुरक्षित रूप से अनक्लेम्ड होने पर एक गंतव्य जॉब रद्द करें",
"description": "स्कोप `posts:publish` और Idempotency-Key चाहिए। पहले से सबमिट की गई डिलीवरी वास्तविक स्थिति के साथ 409 too_late_to_cancel लौटाती हैं।\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"responses": {
"200": {
"description": "Cancellation result",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"delivery",
"requestId"
],
"properties": {
"delivery": {
"type": "object",
"required": [
"deliveryId",
"canceled",
"state"
],
"properties": {
"deliveryId": {
"type": "string"
},
"canceled": {
"type": "boolean"
},
"state": {
"type": "string"
}
}
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /deliveries/{id}/retry
एक ज्ञात विफल गंतव्य का पुनः प्रयास करें
स्कोप posts:publish और Idempotency-Key चाहिए। अज्ञात परिणाम या सफल डिलीवरी अस्वीकार की जाती हैं: पुनः प्रयास पोस्ट डुप्लिकेट कर सकता है।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"deliveries"
],
"summary": "एक ज्ञात विफल गंतव्य का पुनः प्रयास करें",
"description": "स्कोप `posts:publish` और Idempotency-Key चाहिए। अज्ञात परिणाम या सफल डिलीवरी अस्वीकार की जाती हैं: पुनः प्रयास पोस्ट डुप्लिकेट कर सकता है।\n",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"responses": {
"200": {
"description": "Retry accepted",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"delivery",
"requestId"
],
"properties": {
"delivery": {
"type": "object",
"required": [
"deliveryId",
"state"
],
"properties": {
"deliveryId": {
"type": "string"
},
"state": {
"type": "string"
}
}
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /usage
प्लान, अकाउंट/सीट/स्टोरेज उपयोग, एक्टिविटी और रेट जानकारी
स्कोप usage:read चाहिए। किसी भी प्रकार का कोई रिमेनिंग-पोस्ट काउंटर नहीं: हर पेड प्लान पर पोस्टिंग असीमित है।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"usage"
],
"summary": "प्लान, अकाउंट/सीट/स्टोरेज उपयोग, एक्टिविटी और रेट जानकारी",
"description": "स्कोप `usage:read` चाहिए। किसी भी प्रकार का कोई रिमेनिंग-पोस्ट काउंटर नहीं: हर पेड प्लान पर पोस्टिंग असीमित है।\n",
"responses": {
"200": {
"description": "Usage snapshot",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"usage",
"requestId"
],
"properties": {
"usage": {
"$ref": "#/components/schemas/Usage"
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}POST /webhooks
ग्राहक इवेंट गंतव्य रजिस्टर करें
स्कोप webhooks:manage और Idempotency-Key चाहिए। केवल HTTPS; SSRF वैलिडेशन (स्कीम, क्रेडेंशियल, बाउंडेड DNS-रिज़ॉल्व्ड पता) स्टोरेज से पहले चलता है। साइनिंग सीक्रेट केवल पहली क्रिएशन प्रतिक्रिया में लौटाया जाता है: आइडेंपोटेंट रिप्ले एंडपॉइंट बिना सीक्रेट लौटाता है। क्रिएशन टार्गेटेड वेरिफ़िकेशन इवेंट भी क्यू करता है।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"webhooks"
],
"summary": "ग्राहक इवेंट गंतव्य रजिस्टर करें",
"description": "स्कोप `webhooks:manage` और Idempotency-Key चाहिए। केवल HTTPS; SSRF वैलिडेशन (स्कीम, क्रेडेंशियल, बाउंडेड DNS-रिज़ॉल्व्ड पता) स्टोरेज से पहले चलता है। साइनिंग सीक्रेट केवल पहली क्रिएशन प्रतिक्रिया में लौटाया जाता है: आइडेंपोटेंट रिप्ले एंडपॉइंट बिना सीक्रेट लौटाता है। क्रिएशन टार्गेटेड वेरिफ़िकेशन इवेंट भी क्यू करता है।\n",
"parameters": [
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhookRequest"
}
}
}
},
"responses": {
"201": {
"description": "Endpoint created (secret shown once)",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"webhook",
"requestId"
],
"properties": {
"webhook": {
"allOf": [
{
"$ref": "#/components/schemas/WebhookEndpoint"
},
{
"type": "object",
"properties": {
"secret": {
"type": [
"string",
"null"
],
"description": "Present only on the first successful creation; null on replay."
}
}
}
]
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"422": {
"$ref": "#/components/responses/Validation"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}GET /webhooks
इवेंट गंतव्य सूचीबद्ध करें (कोई सीक्रेट नहीं)
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"webhooks"
],
"summary": "इवेंट गंतव्य सूचीबद्ध करें (कोई सीक्रेट नहीं)",
"responses": {
"200": {
"description": "Endpoint list",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"webhooks",
"requestId"
],
"properties": {
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookEndpoint"
}
},
"requestId": {
"type": "string"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}DELETE /webhooks/{id}
इवेंट गंतव्य हटाएँ
स्कोप webhooks:manage और Idempotency-Key चाहिए (दोहराव सुरक्षित है)।
संचालन विवरण में पैरामीटर, अनुरोध बॉडी, प्रतिक्रियाएँ और घटक संदर्भ हैं। संदर्भित परिभाषाएँ नीचे हैं।
{
"tags": [
"webhooks"
],
"summary": "इवेंट गंतव्य हटाएँ",
"description": "स्कोप `webhooks:manage` और Idempotency-Key चाहिए (दोहराव सुरक्षित है)।",
"parameters": [
{
"$ref": "#/components/parameters/id"
},
{
"$ref": "#/components/parameters/idempotencyKey"
}
],
"responses": {
"204": {
"description": "Deleted",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/RateLimited"
}
}
}साझा परिभाषाएँ
securitySchemes
productKey
{
"type": "http",
"scheme": "bearer",
"bearerFormat": "pk_v1_… (product key; NOT a Supabase key)"
}parameters
id
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}cursor
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
}
}limit
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 25
}
}idempotencyKey
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": "वही की + वही नॉर्मलाइज़्ड बॉडी रिकॉर्डेड परिणाम रिप्ले करती है; वही की + अलग बॉडी 409 idempotency_conflict लौटाती है।\n"
}headers
requestId
{
"description": "प्रति-रिक्वेस्ट कोरिलेशन आईडी, एरर एनवेलप में भी इको होती है।",
"schema": {
"type": "string"
}
}retryAfter
{
"description": "अगली रेट-लिमिट विंडो तक सेकंड।",
"schema": {
"type": "integer"
}
}responses
Forbidden
{
"description": "की में आवश्यक स्कोप नहीं है, या संसाधन दूसरे वर्कस्पेस का है।",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}PaymentRequired
{
"description": "एंटाइटलमेंट समस्या (सब्सक्रिप्शन निष्क्रिय, ट्रायल एक्सपायर, अकाउंट/सीट/स्टोरेज सीमा)।",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}NotFound
{
"description": "संसाधन कॉलर के वर्कस्पेस में मौजूद नहीं है।",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}Conflict
{
"description": "वर्ज़न/आइडेंपोटेंसी/रद्दीकरण/सहमति/डिलीवरी-स्थिति संघर्ष।",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}Validation
{
"description": "रिक्वेस्ट बॉडी या गंतव्य कंटेंट वैलिडेशन में विफल।",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}RateLimited
{
"description": "प्रति-वर्कस्पेस तकनीकी रेट लिमिट। केवल गति नियंत्रण: कभी पोस्टिंग कोटा नहीं।",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
},
"Retry-After": {
"$ref": "#/components/headers/retryAfter"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}ServerError
{
"description": "सुरक्षित 5XX (प्रोवाइडर अनुपलब्ध या अप्रत्याशित आंतरिक एरर)। कभी रॉ डायग्नोस्टिक्स नहीं रखता।",
"headers": {
"x-request-id": {
"$ref": "#/components/headers/requestId"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}schemas
Error
{
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code",
"message",
"requestId"
],
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden_scope",
"account_not_allowed",
"account_limit",
"seat_limit",
"storage_limit",
"subscription_inactive",
"trial_expired",
"validation_failed",
"unsupported_format",
"consent_required",
"reconnect_required",
"destination_identity_changed",
"revision_conflict",
"idempotency_conflict",
"too_late_to_cancel",
"media_expired",
"media_deleting",
"rate_limited",
"provider_unavailable",
"submission_unknown",
"destination_conflict",
"not_found",
"internal_error"
]
},
"message": {
"type": "string"
},
"fieldErrors": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"code",
"message"
],
"properties": {
"field": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"destinationErrors": {
"type": "array",
"items": {
"type": "object",
"required": [
"accountId",
"code",
"message"
],
"properties": {
"accountId": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"retryable": {
"type": "boolean"
},
"retryAfterSeconds": {
"type": "integer"
},
"details": {
"type": "object",
"additionalProperties": true,
"description": "Machine-readable extras, e.g. currentVersion for revision_conflict."
},
"requestId": {
"type": "string"
},
"requiresAction": {
"type": "object",
"description": "Session UI handoff for human consent; never contains credentials or grants access.",
"required": [
"type",
"url",
"accountIds"
],
"properties": {
"type": {
"type": "string",
"const": "human_consent"
},
"url": {
"type": "string",
"format": "uri-reference"
},
"accountIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Verified key workspace; the browser must verify membership before switching its selected workspace."
}
}
}
}
}
}
}Account
{
"type": "object",
"required": [
"id",
"network",
"destinationType",
"displayName",
"connectionState"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"network": {
"type": "string",
"example": "instagram"
},
"destinationType": {
"type": "string",
"example": "professional_account"
},
"displayName": {
"type": "string"
},
"connectionState": {
"type": "string",
"example": "connected"
},
"capabilityVersion": {
"type": [
"string",
"null"
]
}
}
}Capability
{
"type": "object",
"required": [
"accountId",
"network"
],
"properties": {
"accountId": {
"type": "string"
},
"network": {
"type": "string"
},
"networkEnabled": {
"type": "boolean"
},
"accountConnected": {
"type": "boolean"
},
"capabilityVersion": {
"type": [
"string",
"null"
]
},
"formats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"format": {
"type": "string",
"enum": [
"text",
"single_image",
"image_set",
"video"
]
},
"maxMediaCount": {
"type": "integer"
},
"maxBytes": {
"type": [
"integer",
"null"
]
},
"requiredFields": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"eligibleVisibility": {
"type": "array",
"items": {
"type": "string"
}
},
"requiresActionReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"verifiedAt": {
"type": "string"
}
}
}UploadIntentRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"filename",
"declaredMime",
"declaredBytes"
],
"properties": {
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"declaredMime": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "image/jpeg"
},
"declaredBytes": {
"type": "integer",
"minimum": 1,
"maximum": 524288000
},
"width": {
"type": "number",
"minimum": 0
},
"height": {
"type": "number",
"minimum": 0
},
"durationMs": {
"type": "number",
"minimum": 0
}
}
}UploadIntent
{
"type": "object",
"required": [
"assetId",
"sessionId",
"objectKey",
"method",
"expiresAt",
"maxBytes"
],
"description": "50 MB से छोटी फ़ाइलें कम-उम्र वाले `uploadUrl` और आवश्यक `headers` के साथ `method: presigned_put` लौटाती हैं। 50 MB या बड़ी फ़ाइलें `partSizeBytes` और प्रीसाइन किए पार्ट URL की `parts` ऐरे के साथ `method: multipart_initiated` लौटाती हैं; हर पार्ट अपलोड करें, फिर हर पार्ट की ETag रसीद के साथ फ़ाइनलाइज़ करें।\n",
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"sessionId": {
"type": "string"
},
"objectKey": {
"type": "string",
"description": "Opaque storage key; never a public URL"
},
"method": {
"type": "string",
"enum": [
"presigned_put",
"multipart_initiated"
]
},
"uploadUrl": {
"type": "string",
"description": "Short-lived; upload bytes directly with the documented method"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Required request headers for the presigned PUT (e.g. content-type)"
},
"partSizeBytes": {
"type": "integer",
"description": "Required part size for multipart uploads"
},
"parts": {
"type": "array",
"description": "Presigned part URLs (multipart_initiated only); request fresh pages when they expire",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"partNumber",
"url",
"expiresAt"
],
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
},
"url": {
"type": "string"
},
"expiresAt": {
"type": "string"
}
}
}
},
"expiresAt": {
"type": "string"
},
"maxBytes": {
"type": "integer"
}
}
}UploadIntentResponse
{
"allOf": [
{
"$ref": "#/components/schemas/UploadIntent"
},
{
"type": "object",
"required": [
"requestId"
],
"properties": {
"requestId": {
"type": "string"
}
}
}
]
}TikTokCreatorSettings
{
"type": "object",
"additionalProperties": false,
"required": [
"privacyLevels",
"maxDurationSeconds",
"allowComments",
"allowDuet",
"allowStitch",
"directPublishingAllowed",
"inboxAllowed",
"nativeAccountId"
],
"properties": {
"privacyLevels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"PUBLIC_TO_EVERYONE",
"MUTUAL_FOLLOW_FRIENDS",
"FOLLOWER_OF_CREATOR",
"SELF_ONLY"
]
}
},
"maxDurationSeconds": {
"type": "number",
"exclusiveMinimum": 0
},
"allowComments": {
"type": "boolean"
},
"allowDuet": {
"type": "boolean"
},
"allowStitch": {
"type": "boolean"
},
"directPublishingAllowed": {
"type": "boolean"
},
"inboxAllowed": {
"type": "boolean"
},
"nativeAccountId": {
"type": "string"
},
"creatorName": {
"type": "string"
},
"creatorAvatarUrl": {
"type": "string",
"format": "uri"
}
}
}MediaStatus
{
"type": "object",
"required": [
"id",
"originalName",
"mimeType",
"bytes",
"uploadState",
"createdAt",
"deletionState"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"originalName": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"bytes": {
"type": "integer"
},
"uploadState": {
"type": "string",
"enum": [
"pending",
"uploading",
"finalized",
"rejected"
]
},
"createdAt": {
"type": "string"
},
"deleteAfter": {
"type": [
"string",
"null"
],
"description": "Dynamic deletion date, or null while kept for scheduled posts."
},
"deletionState": {
"type": "string",
"enum": [
"active",
"deleting",
"deleted"
]
}
}
}FinalizeRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"sessionId"
],
"description": "कॉलर-प्रामाणिक देखे गए तथ्य (बाइट/MIME/चेकसम) स्वीकार नहीं किए जाते: सर्वर अपरिवर्तनीय FINAL कॉपी स्वयं जाँचता है। Multipart अपलोड में हर पार्ट की ETag रसीद शामिल होनी चाहिए।\n",
"properties": {
"sessionId": {
"type": "string",
"format": "uuid"
},
"multipart": {
"type": "object",
"additionalProperties": false,
"required": [
"parts"
],
"properties": {
"parts": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"partNumber",
"etag"
],
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1
},
"etag": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
}
}
}
}
}
}FinalizeResult
{
"type": "object",
"required": [
"assetId",
"finalizeOperationId",
"bytes"
],
"properties": {
"assetId": {
"type": "string",
"format": "uuid"
},
"finalizeOperationId": {
"type": "string"
},
"bytes": {
"type": "integer"
},
"expiresAt": {
"type": [
"string",
"null"
]
}
}
}DraftInput
{
"type": "object",
"additionalProperties": false,
"required": [
"caption",
"destinations"
],
"properties": {
"caption": {
"type": "string",
"maxLength": 70000
},
"mediaIds": {
"type": "array",
"maxItems": 10,
"items": {
"type": "string",
"format": "uuid"
},
"default": []
},
"brandFolderId": {
"type": [
"string",
"null"
],
"format": "uuid",
"default": null
},
"destinations": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/components/schemas/DraftDestination"
}
}
}
}DraftDestination
{
"type": "object",
"additionalProperties": false,
"required": [
"accountId",
"format"
],
"properties": {
"accountId": {
"type": "string",
"format": "uuid"
},
"format": {
"type": "string",
"enum": [
"text",
"single_image",
"image_set",
"video"
]
},
"overrides": {
"type": "object",
"additionalProperties": false,
"properties": {
"caption": {
"type": "string"
},
"mediaIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
"title": {
"type": "string"
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "Validated against an allowlisted per-network schema; never a raw vendor bag."
}
}
}
}
}DraftUpdateInput
{
"allOf": [
{
"$ref": "#/components/schemas/DraftInput"
},
{
"type": "object",
"required": [
"expectedVersion"
],
"properties": {
"expectedVersion": {
"type": "integer",
"minimum": 1
}
}
}
]
}DraftSaveResult
{
"type": "object",
"required": [
"postId",
"version",
"createdAt",
"updatedAt"
],
"properties": {
"postId": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer"
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
}PostListItem
{
"type": "object",
"required": [
"postId",
"version",
"status",
"updatedAt"
],
"properties": {
"postId": {
"type": "string"
},
"version": {
"type": "integer"
},
"status": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
}
}ValidationResult
{
"type": "object",
"required": [
"valid",
"revisionVersion",
"destinationResults"
],
"properties": {
"valid": {
"type": "boolean"
},
"revisionVersion": {
"type": "integer"
},
"destinationResults": {
"type": "array",
"items": {
"type": "object",
"required": [
"accountId",
"valid",
"requiresAction"
],
"properties": {
"accountId": {
"type": "string"
},
"valid": {
"type": "boolean"
},
"requiresAction": {
"type": "boolean",
"description": "True when the network requires an explicit human/consent step."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}AcceptedOperation
{
"type": "object",
"required": [
"revisionId",
"version",
"operationId",
"deliveryIds",
"scheduledAt",
"timezone",
"requestId"
],
"properties": {
"revisionId": {
"type": "string"
},
"version": {
"type": "integer"
},
"operationId": {
"type": "string"
},
"deliveryIds": {
"type": "array",
"items": {
"type": "string"
}
},
"scheduledAt": {
"type": "string"
},
"timezone": {
"type": "string"
},
"requestId": {
"type": "string"
},
"warnings": {
"type": "array",
"description": "Non-blocking notices preserved on replay, including key_expires_before_schedule when a key expires at or before dispatch.",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}ScheduleRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"scheduledAt",
"timezone",
"expectedVersion"
],
"properties": {
"scheduledAt": {
"type": "string",
"format": "date-time",
"example": "2027-01-12T15:00:00Z"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"example": "America/Indiana/Indianapolis"
},
"expectedVersion": {
"type": "integer",
"minimum": 1
},
"revisionId": {
"type": [
"string",
"null"
],
"description": "Must be null in V1 (schedules the current revision); non-null is rejected."
}
}
}PostStatus
{
"type": "object",
"required": [
"postId",
"version",
"status",
"deliveries"
],
"properties": {
"postId": {
"type": "string"
},
"version": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"draft",
"scheduled",
"in_progress",
"published",
"partially_published",
"needs_attention",
"canceled"
]
},
"deliveries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"accountId": {
"type": "string"
},
"network": {
"type": "string"
},
"state": {
"type": "string"
},
"dueAt": {
"type": "string"
},
"nativePostUrl": {
"type": [
"string",
"null"
],
"description": "Only after a confirmed result."
},
"unresolvedExternalOutcome": {
"type": "boolean"
},
"cancelRequestedAt": {
"type": [
"string",
"null"
]
},
"retryCount": {
"type": "integer"
},
"publishedAt": {
"type": [
"string",
"null"
]
}
}
}
}
}
}Usage
{
"type": "object",
"description": "इस स्कीमा में कहीं भी रिमेनिंग-पोस्ट काउंटर नहीं है: हर पेड प्लान पर पोस्टिंग असीमित है। एक्टिविटी संख्याएँ ऑपरेशनल मेट्रिक्स हैं।\n",
"required": [
"plan",
"accounts",
"members",
"storage",
"scheduling",
"rateLimit",
"activity"
],
"properties": {
"plan": {
"type": "object",
"required": [
"id",
"label",
"status"
],
"properties": {
"id": {
"type": "string",
"enum": [
"trial",
"creator",
"studio",
"operator"
]
},
"label": {
"type": "string"
},
"version": {
"type": "integer"
},
"interval": {
"type": [
"string",
"null"
],
"enum": [
"month",
"year",
null
]
},
"status": {
"type": "string"
},
"paidThrough": {
"type": [
"string",
"null"
]
},
"trialEndsAt": {
"type": [
"string",
"null"
]
}
}
},
"accounts": {
"type": "object",
"required": [
"connected",
"reserved",
"maxConnected"
],
"properties": {
"connected": {
"type": "integer"
},
"reserved": {
"type": "integer"
},
"maxConnected": {
"type": "integer"
}
}
},
"members": {
"type": "object",
"required": [
"active",
"max"
],
"properties": {
"active": {
"type": "integer"
},
"max": {
"type": "integer"
}
}
},
"storage": {
"type": "object",
"required": [
"activeBytes",
"reservedBytes",
"maxActiveBytes"
],
"properties": {
"activeBytes": {
"type": "integer"
},
"reservedBytes": {
"type": "integer"
},
"maxActiveBytes": {
"type": "integer"
}
}
},
"scheduling": {
"type": "object",
"required": [
"horizonDays"
],
"properties": {
"horizonDays": {
"type": "integer",
"example": 90
}
}
},
"rateLimit": {
"type": "object",
"required": [
"requestsPerMinute",
"note"
],
"properties": {
"requestsPerMinute": {
"type": "integer",
"example": 120
},
"note": {
"type": "string",
"example": "Technical speed limit: not a posting allowance."
}
}
},
"activity": {
"type": "object",
"description": "Operational metrics only; never an allowance or balance.",
"required": [
"deliveriesAttemptedLast30Days",
"deliveriesPublishedLast30Days"
],
"properties": {
"deliveriesAttemptedLast30Days": {
"type": "integer"
},
"deliveriesPublishedLast30Days": {
"type": "integer"
}
}
}
}
}CreateWebhookRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"example": "https://example.com/hooks/autoposted"
},
"eventTypes": {
"oneOf": [
{
"type": "string",
"const": "all"
},
{
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
],
"description": "Omit or \"all\" for every event; an array filters by event type."
},
"description": {
"type": "string"
}
}
}WebhookEndpoint
{
"type": "object",
"required": [
"id",
"url",
"eventTypes",
"enabled",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"url": {
"type": "string",
"format": "uri"
},
"eventTypes": {
"oneOf": [
{
"type": "string",
"const": "all"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"enabled": {
"type": "boolean"
},
"verifiedAt": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string"
}
}
}