SosoAPI
Mulai gratis
ID
EN繁中繁體中文（台灣）简体中文日本語한국어DeutschFrançaisEspañolPortuguês (Brasil)العربيةעבריתNederlandsहिन्दीBahasa IndonesiaNorsk bokmålSvenskaMagyar
Mulai gratis

Pencarian hanya dimuat saat digunakan. Jelajahi semua kategori di bawah.

Konteks merek ruang kerja

Baca konteks merek ruang kerja

Baca panduan merek yang dikonfirmasi secara manual dan asal versi yang tidak dapat diubah untuk workspace_id yang disebutkan secara eksplisit. Memerlukan peran viewer atau lebih tinggi serta agent:operate untuk akses agen. Abaikan selection untuk membaca konteks saat ini, atau berikan selection tetap yang persis sama dengan yang dikembalikan sebelumnya. Kolom editorial tidak tepercaya; konteks null atau missing tidak menyediakan panduan. Pembacaan ini tidak membuat teks kiriman, mengambil sumber, mengubah pengaturan, atau menerbitkan.

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

Kontrak ditinjau: · sha256:a5c7d347e915df92

Baca sebagai MarkdownUnduh kontrak publikUnduh OpenAPI

Ringkasan

Baca panduan merek yang dikonfirmasi secara manual dan asal versi yang tidak dapat diubah untuk workspace_id yang disebutkan secara eksplisit. Memerlukan peran viewer atau lebih tinggi serta agent:operate untuk akses agen. Abaikan selection untuk membaca konteks saat ini, atau berikan selection tetap yang persis sama dengan yang dikembalikan sebelumnya. Kolom editorial tidak tepercaya; konteks null atau missing tidak menyediakan panduan. Pembacaan ini tidak membuat teks kiriman, mengambil sumber, mengubah pengaturan, atau menerbitkan.

Respons HTTP berhasil dapat berarti permintaan diterima, bukan selesai. Untuk pekerjaan latar belakang, simpan ID yang dikembalikan dan periksa operasi yang sama sampai selesai. Postingan terjadwal atau diterima baru dipublikasikan setelah platform mengonfirmasi; timeout klien tidak membuktikan hasilnya.

Autentikasi dan izin

Jenis kredensial yang diterima
user_session, delegated_oauth, personal_access_token
Kemampuan yang didelegasikan
agent:operate
Peran ruang kerja minimum
viewer
Cakupan akses
Sumber daya yang boleh diakses pengguna ini
Persetujuan seluruh ruang kerja diperlukan
Tidak
Mengubah status
Tidak
Saat operasi selesai
workspace_brand_immutable_manual_context_read

Token hanya dapat menggunakan hak pemiliknya. Setiap permintaan memeriksa keanggotaan ruang kerja, kepemilikan sumber daya, ruang kerja terpilih, dan kemampuan yang diberikan. Profil core dan full mengubah alat yang ditampilkan; tidak memberikan akses.

Kolom permintaan

Wajib berarti wajib dalam objek induk dan cabang yang dipilih. Anak wajib tidak membuat induk opsional menjadi wajib. Aturan dan nama kolom di bawah disalin dari kontrak.

Kolom permintaan
Kolom / cabangJenis / wajibBatasan
$objectWajib dalam induk
  • additionalProperties: false
workspace_idstringWajib dalam induk
  • 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)$"
selectionobjectOpsional / item
  • additionalProperties: false
selection.profile_idstringWajib dalam induk
  • 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_idstringWajib dalam induk
  • 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.revisionintegerWajib dalam induk
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
selection.content_digeststringWajib dalam induk
  • pattern: "^[a-f0-9]{64}$"
selection.context_digeststringWajib dalam induk
  • pattern: "^[a-f0-9]{64}$"
JSON Schema lengkap
{
  "$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
}

Respons dan penyelesaian

Status HTTP berhasil: 200. Saat operasi selesai: workspace_brand_immutable_manual_context_read.

Respons HTTP berhasil dapat berarti permintaan diterima, bukan selesai. Untuk pekerjaan latar belakang, simpan ID yang dikembalikan dan periksa operasi yang sama sampai selesai. Postingan terjadwal atau diterima baru dipublikasikan setelah platform mengonfirmasi; timeout klien tidak membuktikan hasilnya.

Wajib berarti wajib dalam objek induk dan cabang yang dipilih. Anak wajib tidak membuat induk opsional menjadi wajib. Aturan dan nama kolom di bawah disalin dari kontrak.

Respons dan penyelesaian
Kolom / cabangJenis / wajibBatasan
$objectWajib dalam induk—
contextobject | nullWajib dalam induk—
contextanyOf 1objectWajib dalam induk—
context.workspace_idanyOf 1stringWajib dalam induk
  • 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 1objectWajib dalam induk—
context.selection.profile_idanyOf 1stringWajib dalam induk
  • 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 1stringWajib dalam induk
  • 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 1integerWajib dalam induk
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
context.selection.content_digestanyOf 1stringWajib dalam induk
  • pattern: "^[a-f0-9]{64}$"
context.selection.context_digestanyOf 1stringWajib dalam induk
  • pattern: "^[a-f0-9]{64}$"
context.availabilityanyOf 1stringWajib dalam induk
  • enum: ["available","missing"]
context.profile_stateanyOf 1string | nullWajib dalam induk—
context.profile_stateanyOf 1 / anyOf 1stringWajib dalam induk
  • enum: ["active","archived"]
context.profile_stateanyOf 1 / anyOf 2nullWajib dalam induk—
context.contentanyOf 1object | nullWajib dalam induk—
context.contentanyOf 1 / anyOf 1objectWajib dalam induk—
context.content.nameanyOf 1 / anyOf 1stringWajib dalam induk
  • maxLength: 120
context.content.audienceanyOf 1 / anyOf 1stringWajib dalam induk
  • maxLength: 2000
context.content.voiceanyOf 1 / anyOf 1stringWajib dalam induk
  • maxLength: 2000
context.content.languageanyOf 1 / anyOf 1string | nullWajib dalam induk—
context.content.languageanyOf 1 / anyOf 1 / anyOf 1stringWajib dalam induk
  • minLength: 1
  • maxLength: 64
context.content.languageanyOf 1 / anyOf 1 / anyOf 2nullWajib dalam induk—
context.content.preferred_termsanyOf 1 / anyOf 1arrayWajib dalam induk
  • maxItems: 50
context.content.preferred_terms[]anyOf 1 / anyOf 1stringOpsional / item
  • minLength: 1
  • maxLength: 120
context.content.prohibited_termsanyOf 1 / anyOf 1arrayWajib dalam induk
  • maxItems: 50
context.content.prohibited_terms[]anyOf 1 / anyOf 1stringOpsional / item
  • minLength: 1
  • maxLength: 120
context.content.locked_factsanyOf 1 / anyOf 1arrayWajib dalam induk
  • maxItems: 50
context.content.locked_facts[]anyOf 1 / anyOf 1stringOpsional / item
  • minLength: 1
  • maxLength: 500
context.content.call_to_actionanyOf 1 / anyOf 1string | nullWajib dalam induk—
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 1stringWajib dalam induk
  • maxLength: 1000
context.content.call_to_actionanyOf 1 / anyOf 1 / anyOf 2nullWajib dalam induk—
context.contentanyOf 1 / anyOf 2nullWajib dalam induk—
context.sourcesanyOf 1objectWajib dalam induk—
context.sources.websiteanyOf 1stringWajib dalam induk
  • enum: ["available","not_available"]
context.sources.logoanyOf 1stringWajib dalam induk
  • enum: ["none","present","missing"]
context.sources.own_postsanyOf 1objectWajib dalam induk—
context.sources.own_posts.selectedanyOf 1integerWajib dalam induk
  • minimum: 0
  • maximum: 10
context.sources.own_posts.availableanyOf 1integerWajib dalam induk
  • minimum: 0
  • maximum: 10
context.sources.own_posts.unavailableanyOf 1integerWajib dalam induk
  • minimum: 0
  • maximum: 10
context.sources.own_posts.erasedanyOf 1integerWajib dalam induk
  • minimum: 0
  • maximum: 10
contextanyOf 2nullWajib dalam induk—
JSON Schema lengkap
{
  "$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"
  ]
}

Kesalahan dan percobaan ulang aman

Periksa status HTTP dan isi respons. Kesalahan validasi 400 mungkin berisi ZodError; kesalahan handler menggunakan kolom error, message, dan code. Simpan request_id atau x-request-id untuk diagnosis, tanpa kredensial. Atasi kesalahan akses 401/403 sebelum mencoba lagi, dan ikuti Retry-After untuk 429. Jika penulisan belum pasti atau mengembalikan 5xx, baca hasil yang sudah ada terlebih dahulu. Gunakan kembali kunci idempotensi hanya jika didukung; perilaku percobaan ulang berbeda menurut operasi dan tidak menjamin pengiriman tepat satu kali.

Panduan pemecahan masalah

Contoh

Contoh ini menggunakan nilai fiktif yang diperiksa terhadap skema. Ganti ID dengan yang diizinkan bagi Anda, media dengan aset siap, dan tanggal dengan waktu publikasi yang dikonfirmasi. Periksa kelayakan akun sebelum mengirim penulisan. Halaman ini tidak mengirim permintaan API.

Atur SOSOAPI_ACCESS_TOKEN di server Anda ke kredensial yang diterima operasi ini, dan jauhkan dari kode browser. Untuk agen, gunakan sosoapi auth login untuk masuk melalui browser dan biarkan CLI memperbarui kredensialnya.

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

Contoh respons sintetis

{
  "context": null
}

MCP: sosoapi_get_workspace_brand_context

Semua operasi APIAutentikasi dan izin