Listening és említések
Listening-adatfolyam frissítése
Az adatfolyam beállításainak cseréje expected_revision használatával; a módosult keresések kizárják a korábbi gyűjtést, és új engedélyt igényelnek. agent:research szükséges.
POST /listening-api/streams/updateSzerződés ellenőrizve: · sha256:ab393e91e9b7f18a
Áttekintés
Az adatfolyam beállításainak cseréje expected_revision használatával; a módosult keresések kizárják a korábbi gyűjtést, és új engedélyt igényelnek. agent:research szükséges.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
Hitelesítés és engedélyek
A token csak a tulajdonosa jogait használhatja. Minden kérés ellenőrzi a munkaterületi tagságot, erőforrás-tulajdonjogot, kiválasztott munkaterületeket és megadott képességeket. A core és full profil a megjelenített eszközöket változtatja; hozzáférést nem ad.
Kérésmezők
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező |
|
workspace_id | stringA szülőn belül kötelező |
|
mutation_id | stringA szülőn belül kötelező |
|
id | stringA szülőn belül kötelező |
|
expected_revision | integerA szülőn belül kötelező |
|
content | objectA szülőn belül kötelező |
|
content.name | stringA szülőn belül kötelező |
|
content.query | stringA szülőn belül kötelező |
|
content.source_overrides | objectOpcionális / elem |
|
content.source_overrides.hacker_news | stringOpcionális / elem |
|
content.include_terms | arrayOpcionális / elem |
|
content.include_terms[] | stringOpcionális / elem |
|
content.exclude_terms | arrayOpcionális / elem |
|
content.exclude_terms[] | stringOpcionális / elem |
|
content.item_types | arrayOpcionális / elem |
|
content.item_types[] | stringOpcionális / elem |
|
content.cadence_minutes | integerOpcionális / elem |
|
content.lookback_days | integerOpcionális / elem |
|
Teljes 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)$"
},
"mutation_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"expected_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"content": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"query": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_overrides": {
"default": {},
"type": "object",
"properties": {
"hacker_news": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"additionalProperties": false
},
"include_terms": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"exclude_terms": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"item_types": {
"default": [
"story",
"comment"
],
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"story",
"comment"
]
}
},
"cadence_minutes": {
"default": 60,
"type": "integer",
"minimum": 30,
"maximum": 1440
},
"lookback_days": {
"default": 7,
"type": "integer",
"minimum": 1,
"maximum": 7
}
},
"required": [
"name",
"query"
],
"additionalProperties": false
}
},
"required": [
"workspace_id",
"mutation_id",
"id",
"expected_revision",
"content"
],
"additionalProperties": false
}Válasz és befejezés
Sikeres HTTP-állapotok: 200. A művelet befejezésekor: committed Listening resource version or cancellation fence; no social platform writes.
A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.
A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.
| Mező / ág | Típus / kötelező | Korlátok |
|---|---|---|
$ | objectA szülőn belül kötelező | — |
stream | objectA szülőn belül kötelező | — |
stream.id | stringA szülőn belül kötelező |
|
stream.workspace_id | stringA szülőn belül kötelező |
|
stream.revision | integerA szülőn belül kötelező |
|
stream.query_revision | integerA szülőn belül kötelező |
|
stream.generation | integerA szülőn belül kötelező |
|
stream.source | stringA szülőn belül kötelező |
|
stream.content | objectA szülőn belül kötelező | — |
stream.content.name | stringA szülőn belül kötelező |
|
stream.content.query | stringA szülőn belül kötelező |
|
stream.content.source_overrides | objectA szülőn belül kötelező |
|
stream.content.source_overrides.hacker_news | stringOpcionális / elem |
|
stream.content.include_terms | arrayA szülőn belül kötelező |
|
stream.content.include_terms[] | stringOpcionális / elem |
|
stream.content.exclude_terms | arrayA szülőn belül kötelező |
|
stream.content.exclude_terms[] | stringOpcionális / elem |
|
stream.content.item_types | arrayA szülőn belül kötelező |
|
stream.content.item_types[] | stringOpcionális / elem |
|
stream.content.cadence_minutes | integerA szülőn belül kötelező |
|
stream.content.lookback_days | integerA szülőn belül kötelező |
|
stream.state | stringA szülőn belül kötelező |
|
stream.authorization_expires_at | string | nullA szülőn belül kötelező | — |
stream.authorization_expires_atanyOf 1 | stringA szülőn belül kötelező |
|
stream.authorization_expires_atanyOf 2 | nullA szülőn belül kötelező | — |
stream.last_attempt_at | string | nullA szülőn belül kötelező | — |
stream.last_attempt_atanyOf 1 | stringA szülőn belül kötelező |
|
stream.last_attempt_atanyOf 2 | nullA szülőn belül kötelező | — |
stream.last_success_at | string | nullA szülőn belül kötelező | — |
stream.last_success_atanyOf 1 | stringA szülőn belül kötelező |
|
stream.last_success_atanyOf 2 | nullA szülőn belül kötelező | — |
stream.next_due_at | string | nullA szülőn belül kötelező | — |
stream.next_due_atanyOf 1 | stringA szülőn belül kötelező |
|
stream.next_due_atanyOf 2 | nullA szülőn belül kötelező | — |
stream.created_at | stringA szülőn belül kötelező |
|
stream.updated_at | stringA szülőn belül kötelező |
|
Teljes JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"stream": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"query_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"generation": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"const": "hacker_news"
},
"content": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"query": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_overrides": {
"default": {},
"type": "object",
"properties": {
"hacker_news": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
}
},
"include_terms": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"exclude_terms": {
"default": [],
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"item_types": {
"default": [
"story",
"comment"
],
"minItems": 1,
"maxItems": 2,
"type": "array",
"items": {
"type": "string",
"enum": [
"story",
"comment"
]
}
},
"cadence_minutes": {
"default": 60,
"type": "integer",
"minimum": 30,
"maximum": 1440
},
"lookback_days": {
"default": 7,
"type": "integer",
"minimum": 1,
"maximum": 7
}
},
"required": [
"name",
"query",
"source_overrides",
"include_terms",
"exclude_terms",
"item_types",
"cadence_minutes",
"lookback_days"
]
},
"state": {
"type": "string",
"enum": [
"active",
"paused",
"needs_reauthorization",
"deleted"
]
},
"authorization_expires_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"last_attempt_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"last_success_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"next_due_at": {
"anyOf": [
{
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"updated_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
}
},
"required": [
"id",
"workspace_id",
"revision",
"query_revision",
"generation",
"source",
"content",
"state",
"authorization_expires_at",
"last_attempt_at",
"last_success_at",
"next_due_at",
"created_at",
"updated_at"
]
}
},
"required": [
"stream"
]
}Hibák és biztonságos újrapróbálás
Ellenőrizd a HTTP-állapotot és a válasz törzsét. A 400 ellenőrzési hiba ZodError értéket tartalmazhat; a kezelőhibák az error, message és code mezőket használják. Őrizd meg a request_id vagy x-request-id értéket a diagnózishoz, hitelesítő adatok nélkül. Újrapróbálás előtt javítsd a 401/403 hozzáférési hibákat; 429 esetén kövesd a Retry-After értékét. Bizonytalan írás vagy 5xx válasz esetén előbb olvasd el a meglévő eredményt. Csak támogatott műveletnél használj újra idempotenciakulcsot; az újrapróbálás műveletenként eltér, és nem garantál pontosan egyszeri kézbesítést.
Hibaelhárítási útmutatóPéldák
A példák sémákkal ellenőrzött képzeletbeli értékeket használnak. Az azonosítókat engedélyezettekre, a médiát kész tartalomelemekre, a dátumokat megerősített közzétételi időpontra cseréld. Írás beküldése előtt ellenőrizd a fiók jogosultságát. Ez az oldal nem küld API-kérést.
A szervereden állítsd a SOSOAPI_ACCESS_TOKEN értékét a művelet által elfogadott hitelesítő adatra, és tartsd távol a böngészőkódtól. AI-ügynökhöz a sosoapi auth login paranccsal jelentkezz be böngészőben, és hagyd, hogy a CLI frissítse a hitelesítő adatokat.
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111",
"id": "11111111-1111-4111-8111-111111111111",
"expected_revision": 1,
"content": {
"name": "example",
"query": "example"
}
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/streams/update" \
-H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data-binary @request.jsonJavaScript
// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/streams/update", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "11111111-1111-4111-8111-111111111111",
"id": "11111111-1111-4111-8111-111111111111",
"expected_revision": 1,
"content": {
"name": "example",
"query": "example"
}
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /listening-api/streams/update < request.jsonSzintetikus válaszpélda
{
"stream": {
"id": "11111111-1111-4111-8111-111111111111",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"query_revision": 1,
"generation": 1,
"source": "hacker_news",
"content": {
"name": "example",
"query": "example",
"source_overrides": {},
"include_terms": [],
"exclude_terms": [],
"item_types": [
"story",
"comment"
],
"cadence_minutes": 60,
"lookback_days": 7
},
"state": "active",
"authorization_expires_at": null,
"last_attempt_at": null,
"last_success_at": null,
"next_due_at": null,
"created_at": "2099-01-15T09:00:00Z",
"updated_at": "2099-01-15T09:00:00Z"
}
}