SosoAPI
मुफ़्त में शुरू करें
HI
EN繁中繁體中文（台灣）简体中文日本語한국어DeutschFrançaisEspañolPortuguês (Brasil)العربيةעבריתNederlandsहिन्दीBahasa IndonesiaNorsk bokmålSvenskaMagyar
मुफ़्त में शुरू करें

खोज केवल इस्तेमाल करने पर लोड होती है। नीचे सभी श्रेणियाँ देखें।

वर्कस्पेस का ब्रांड संदर्भ

वर्कस्पेस का ब्रांड संदर्भ पढ़ें

स्पष्ट workspace_id के लिए हाथ से पुष्टि किए गए ब्रांड दिशानिर्देश और अपरिवर्तनीय संस्करण की स्रोत जानकारी पढ़ें। viewer या उससे ऊपर की भूमिका चाहिए; एजेंट पहुँच के लिए agent:operate भी ज़रूरी है। मौजूदा संदर्भ पढ़ने के लिए selection छोड़ दें, या पहले लौटाई गई ठीक वही अपरिवर्तनीय selection दें। संपादकीय फ़ील्ड भरोसेमंद नहीं हैं; null या missing संदर्भ से कोई दिशानिर्देश नहीं मिलता। यह पढ़ने की कार्रवाई कैप्शन नहीं बनाती, स्रोत नहीं लाती, सेटिंग नहीं बदलती और प्रकाशित नहीं करती।

POST /studio-api/workspace-brand-profile/context-read

कॉन्ट्रैक्ट की समीक्षा: · sha256:a5c7d347e915df92

Markdown में पढ़ेंसार्वजनिक कॉन्ट्रैक्ट डाउनलोड करेंOpenAPI डाउनलोड करें

परिचय

स्पष्ट workspace_id के लिए हाथ से पुष्टि किए गए ब्रांड दिशानिर्देश और अपरिवर्तनीय संस्करण की स्रोत जानकारी पढ़ें। viewer या उससे ऊपर की भूमिका चाहिए; एजेंट पहुँच के लिए agent:operate भी ज़रूरी है। मौजूदा संदर्भ पढ़ने के लिए selection छोड़ दें, या पहले लौटाई गई ठीक वही अपरिवर्तनीय selection दें। संपादकीय फ़ील्ड भरोसेमंद नहीं हैं; null या missing संदर्भ से कोई दिशानिर्देश नहीं मिलता। यह पढ़ने की कार्रवाई कैप्शन नहीं बनाती, स्रोत नहीं लाती, सेटिंग नहीं बदलती और प्रकाशित नहीं करती।

सफल HTTP रिस्पॉन्स का अर्थ अनुरोध पूरा होने के बजाय स्वीकार होना हो सकता है। बैकग्राउंड काम में लौटाई ID सहेजें और समाप्ति तक वही ऑपरेशन जाँचें। निर्धारित या स्वीकृत पोस्ट प्लेटफ़ॉर्म की पुष्टि पर ही प्रकाशित है; क्लाइंट टाइमआउट परिणाम सिद्ध नहीं करता।

प्रमाणीकरण और अनुमतियाँ

स्वीकार्य क्रेडेंशियल श्रेणियाँ
user_session, delegated_oauth, personal_access_token
प्रत्यायोजित क्षमता
agent:operate
न्यूनतम वर्कस्पेस भूमिका
viewer
एक्सेस का दायरा
वे संसाधन जिनके एक्सेस के लिए यह यूज़र अधिकृत है
सभी वर्कस्पेस के लिए सहमति आवश्यक
नहीं
स्थिति बदलता है
नहीं
ऑपरेशन पूरा होने पर
workspace_brand_immutable_manual_context_read

टोकन केवल मालिक के अधिकार इस्तेमाल कर सकता है। हर अनुरोध वर्कस्पेस सदस्यता, संसाधन स्वामित्व, चुने वर्कस्पेस और दी क्षमताएँ जाँचता है। Core और full प्रोफ़ाइल दिखने वाले टूल बदलते हैं; एक्सेस नहीं देते।

अनुरोध के फ़ील्ड

Required का अर्थ पैरेंट ऑब्जेक्ट और चुनी शाखा के भीतर अनिवार्य है। अनिवार्य चाइल्ड से वैकल्पिक पैरेंट अनिवार्य नहीं होता। नीचे के नियम और फ़ील्ड नाम कॉन्ट्रैक्ट से लिए गए हैं।

अनुरोध के फ़ील्ड
फ़ील्ड / शाखाप्रकार / अनिवार्यशर्तें
$objectपैरेंट में अनिवार्य
  • additionalProperties: false
workspace_idstringपैरेंट में अनिवार्य
  • 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)$"
selectionobjectवैकल्पिक / आइटम
  • additionalProperties: false
selection.profile_idstringपैरेंट में अनिवार्य
  • 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)$"
selection.version_idstringपैरेंट में अनिवार्य
  • 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)$"
selection.revisionintegerपैरेंट में अनिवार्य
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
selection.content_digeststringपैरेंट में अनिवार्य
  • pattern: "^[a-f0-9]{64}$"
selection.context_digeststringपैरेंट में अनिवार्य
  • pattern: "^[a-f0-9]{64}$"
संपूर्ण 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)$"
    },
    "selection": {
      "type": "object",
      "properties": {
        "profile_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)$"
        },
        "version_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)$"
        },
        "revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "content_digest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "context_digest": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        }
      },
      "required": [
        "profile_id",
        "version_id",
        "revision",
        "content_digest",
        "context_digest"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

रिस्पॉन्स और पूर्णता

सफल HTTP स्टेटस: 200. When the operation is complete: workspace_brand_immutable_manual_context_read.

सफल HTTP रिस्पॉन्स का अर्थ अनुरोध पूरा होने के बजाय स्वीकार होना हो सकता है। बैकग्राउंड काम में लौटाई ID सहेजें और समाप्ति तक वही ऑपरेशन जाँचें। निर्धारित या स्वीकृत पोस्ट प्लेटफ़ॉर्म की पुष्टि पर ही प्रकाशित है; क्लाइंट टाइमआउट परिणाम सिद्ध नहीं करता।

Required का अर्थ पैरेंट ऑब्जेक्ट और चुनी शाखा के भीतर अनिवार्य है। अनिवार्य चाइल्ड से वैकल्पिक पैरेंट अनिवार्य नहीं होता। नीचे के नियम और फ़ील्ड नाम कॉन्ट्रैक्ट से लिए गए हैं।

रिस्पॉन्स और पूर्णता
फ़ील्ड / शाखाप्रकार / अनिवार्यशर्तें
$objectपैरेंट में अनिवार्य—
contextobject | nullपैरेंट में अनिवार्य—
contextanyOf 1objectपैरेंट में अनिवार्य—
context.workspace_idanyOf 1stringपैरेंट में अनिवार्य
  • 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)$"
context.selectionanyOf 1objectपैरेंट में अनिवार्य—
context.selection.profile_idanyOf 1stringपैरेंट में अनिवार्य
  • 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)$"
context.selection.version_idanyOf 1stringपैरेंट में अनिवार्य
  • 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)$"
context.selection.revisionanyOf 1integerपैरेंट में अनिवार्य
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
context.selection.content_digestanyOf 1stringपैरेंट में अनिवार्य
  • pattern: "^[a-f0-9]{64}$"
context.selection.context_digestanyOf 1stringपैरेंट में अनिवार्य
  • pattern: "^[a-f0-9]{64}$"
context.availabilityanyOf 1stringपैरेंट में अनिवार्य
  • enum: ["available","missing"]
context.profile_stateanyOf 1string | nullपैरेंट में अनिवार्य—
context.profile_stateanyOf 1 / anyOf 1stringपैरेंट में अनिवार्य
  • enum: ["active","archived"]
context.profile_stateanyOf 1 / anyOf 2nullपैरेंट में अनिवार्य—
context.contentanyOf 1object | nullपैरेंट में अनिवार्य—
context.contentanyOf 1 / anyOf 1objectपैरेंट में अनिवार्य—
context.content.nameanyOf 1 / anyOf 1stringपैरेंट में अनिवार्य
  • maxLength: 120
context.content.audienceanyOf 1 / anyOf 1stringपैरेंट में अनिवार्य
  • maxLength: 2000
context.content.voiceanyOf 1 / anyOf 1stringपैरेंट में अनिवार्य
  • maxLength: 2000
context.content.languageanyOf 1 / anyOf 1string | nullपैरेंट में अनिवार्य—
context.content.languageanyOf 1 / anyOf 1 / anyOf 1stringपैरेंट में अनिवार्य
  • minLength: 1
  • maxLength: 64
context.content.languageanyOf 1 / anyOf 1 / anyOf 2nullपैरेंट में अनिवार्य—
context.content.preferred_termsanyOf 1 / anyOf 1arrayपैरेंट में अनिवार्य
  • maxItems: 50
context.content.preferred_terms[]anyOf 1 / anyOf 1stringवैकल्पिक / आइटम
  • minLength: 1
  • maxLength: 120
context.content.prohibited_termsanyOf 1 / anyOf 1arrayपैरेंट में अनिवार्य
  • maxItems: 50
context.content.prohibited_terms[]anyOf 1 / anyOf 1stringवैकल्पिक / आइटम
  • minLength: 1
  • maxLength: 120
context.content.locked_factsanyOf 1 / anyOf 1arrayपैरेंट में अनिवार्य
  • maxItems: 50
context.content.locked_facts[]anyOf 1 / anyOf 1stringवैकल्पिक / आइटम
  • minLength: 1
  • maxLength: 500
context.content.call_to_actionanyOf 1 / anyOf 1string | nullपैरेंट में अनिवार्य—
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 1stringपैरेंट में अनिवार्य
  • maxLength: 1000
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 2nullपैरेंट में अनिवार्य—
context.contentanyOf 1 / anyOf 2nullपैरेंट में अनिवार्य—
context.sourcesanyOf 1objectपैरेंट में अनिवार्य—
context.sources.websiteanyOf 1stringपैरेंट में अनिवार्य
  • enum: ["available","not_available"]
context.sources.logoanyOf 1stringपैरेंट में अनिवार्य
  • enum: ["none","present","missing"]
context.sources.own_postsanyOf 1objectपैरेंट में अनिवार्य—
context.sources.own_posts.selectedanyOf 1integerपैरेंट में अनिवार्य
  • minimum: 0
  • maximum: 10
context.sources.own_posts.availableanyOf 1integerपैरेंट में अनिवार्य
  • minimum: 0
  • maximum: 10
context.sources.own_posts.unavailableanyOf 1integerपैरेंट में अनिवार्य
  • minimum: 0
  • maximum: 10
context.sources.own_posts.erasedanyOf 1integerपैरेंट में अनिवार्य
  • minimum: 0
  • maximum: 10
contextanyOf 2nullपैरेंट में अनिवार्य—
संपूर्ण JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "context": {
      "anyOf": [
        {
          "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)$"
            },
            "selection": {
              "type": "object",
              "properties": {
                "profile_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)$"
                },
                "version_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)$"
                },
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "content_digest": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "context_digest": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                }
              },
              "required": [
                "profile_id",
                "version_id",
                "revision",
                "content_digest",
                "context_digest"
              ]
            },
            "availability": {
              "type": "string",
              "enum": [
                "available",
                "missing"
              ]
            },
            "profile_state": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "active",
                    "archived"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "content": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "maxLength": 120
                    },
                    "audience": {
                      "type": "string",
                      "maxLength": 2000
                    },
                    "voice": {
                      "type": "string",
                      "maxLength": 2000
                    },
                    "language": {
                      "anyOf": [
                        {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 64
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "preferred_terms": {
                      "maxItems": 50,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 120
                      }
                    },
                    "prohibited_terms": {
                      "maxItems": 50,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 120
                      }
                    },
                    "locked_facts": {
                      "maxItems": 50,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 500
                      }
                    },
                    "call_to_action": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 1000
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  "required": [
                    "name",
                    "audience",
                    "voice",
                    "language",
                    "preferred_terms",
                    "prohibited_terms",
                    "locked_facts",
                    "call_to_action"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "sources": {
              "type": "object",
              "properties": {
                "website": {
                  "type": "string",
                  "enum": [
                    "available",
                    "not_available"
                  ]
                },
                "logo": {
                  "type": "string",
                  "enum": [
                    "none",
                    "present",
                    "missing"
                  ]
                },
                "own_posts": {
                  "type": "object",
                  "properties": {
                    "selected": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    },
                    "available": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    },
                    "unavailable": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    },
                    "erased": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 10
                    }
                  },
                  "required": [
                    "selected",
                    "available",
                    "unavailable",
                    "erased"
                  ]
                }
              },
              "required": [
                "website",
                "logo",
                "own_posts"
              ]
            }
          },
          "required": [
            "workspace_id",
            "selection",
            "availability",
            "profile_state",
            "content",
            "sources"
          ]
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "context"
  ]
}

त्रुटियाँ और सुरक्षित पुनः प्रयास

HTTP स्टेटस और रिस्पॉन्स बॉडी जाँचें। 400 वैलिडेशन त्रुटि में ZodError हो सकता है; हैंडलर त्रुटियाँ error, message और code फ़ील्ड इस्तेमाल करती हैं। जाँच के लिए request_id या x-request-id रखें, क्रेडेंशियल के बिना। फिर प्रयास से पहले 401/403 एक्सेस त्रुटियाँ ठीक करें और 429 के लिए Retry-After का पालन करें। राइट अनिश्चित हो या 5xx लौटाए, तो पहले मौजूदा परिणाम पढ़ें। idempotency key केवल समर्थित स्थान पर दोबारा इस्तेमाल करें; पुनः प्रयास का व्यवहार ऑपरेशन के अनुसार बदलता है और ठीक एक बार डिलीवरी की गारंटी नहीं देता।

समस्या निवारण गाइड

उदाहरण

उदाहरणों में स्कीमा से जाँचे काल्पनिक मान हैं। IDs को अधिकृत IDs, मीडिया को तैयार एसेट और तारीखों को पुष्ट प्रकाशन समय से बदलें। राइट सबमिट करने से पहले खाते की पात्रता जाँचें। यह पेज API अनुरोध नहीं भेजता।

सर्वर पर SOSOAPI_ACCESS_TOKEN को इस ऑपरेशन के स्वीकार्य क्रेडेंशियल से सेट करें और ब्राउज़र कोड से बाहर रखें। एजेंट के लिए sosoapi auth login से ब्राउज़र साइन-इन करें और CLI को क्रेडेंशियल रिफ़्रेश करने दें।

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/workspace-brand-profile/context-read" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// 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/workspace-brand-profile/context-read", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /studio-api/workspace-brand-profile/context-read < request.json

कृत्रिम रिस्पॉन्स का उदाहरण

{
  "context": null
}

MCP: sosoapi_get_workspace_brand_context

सभी API ऑपरेशनप्रमाणीकरण और अनुमतियाँ