SosoAPI
ابدأ مجانًا
AR
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 قبول الطلب لا اكتماله. للعمل الخلفي، احفظ المعرّف المُعاد وتابع العملية نفسها حتى تنتهي. لا يُعدّ المنشور المجدول أوالمقبول منشوراً حتى تأكيد المنصة؛ انتهاء مهلة العميل لا يثبت النتيجة.

المصادقة والأذونات

فئات بيانات الاعتماد المقبولة
user_session, delegated_oauth, personal_access_token
إمكانية مفوّضة
agent:operate
الحد الأدنى لدور مساحة العمل
viewer
نطاق الوصول
الموارد التي يحق لهذا المستخدم الوصول إليها
تلزم موافقة تشمل جميع مساحات العمل
لا
يغيّر الحالة
لا
متى تُعدّ العملية مكتملة
workspace_brand_immutable_manual_context_read

لا يستخدم الرمز إلا حقوق مالكه. يفحص كل طلب عضوية مساحة العمل وملكية المورد والمساحات المحددة والإمكانات الممنوحة. يغيّر core و full الأدوات المعروضة؛ ولا يمنحان وصولاً.

حقول الطلب

تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.

حقول الطلب
الحقل / الفرعالنوع / مطلوبالقيود
$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. عندما تكتمل العملية: workspace_brand_immutable_manual_context_read.

قد يعني نجاح HTTP قبول الطلب لا اكتماله. للعمل الخلفي، احفظ المعرّف المُعاد وتابع العملية نفسها حتى تنتهي. لا يُعدّ المنشور المجدول أوالمقبول منشوراً حتى تأكيد المنصة؛ انتهاء مهلة العميل لا يثبت النتيجة.

تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.

الاستجابة والاكتمال
الحقل / الفرعالنوع / مطلوبالقيود
$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 قبل المحاولة واتّبع Retry-After لـ 429. لكتابة غير مؤكدة أو 5xx، اقرأ الموجود أولاً. أعِد مفتاح منع التكرار حيث يُدعم فقط؛ تختلف المحاولة حسب العملية ولا تضمن التسليم مرة واحدة بالضبط.

دليل استكشاف الأخطاء وإصلاحها

أمثلة

تستخدم الأمثلة قيماً خيالية مفحوصة بالمخططات. استبدل المعرّفات بالمفوّض لك، والوسائط بأصول جاهزة، والتواريخ بوقت نشر مؤكد. افحص أهلية الحساب قبل الكتابة. لا تُرسل الصفحة طلبات 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المصادقة والأذونات