Forskning og notater med kildehenvisninger

Eksporter et gjennomgått forskningsnotat med kildehenvisninger

Eksporter et gjennomgått notat eller den nøyaktige gjennomgåtte varianten som ikke-klarert Markdown; gjeldende kildetilgang kontrolleres på nytt. Krever agent:research.

POST /research-api/briefs/export

Kontrakt gjennomgått: 2026-11-03 · sha256:ab393e91e9b7f18a

Les som Markdown Last ned offentlig kontrakt Last ned OpenAPI

Oversikt

Eksporter et gjennomgått notat eller den nøyaktige gjennomgåtte varianten som ikke-klarert Markdown; gjeldende kildetilgang kontrolleres på nytt. Krever agent:research.

Et vellykket HTTP-svar kan bety at en forespørsel er akseptert fremfor fullført. For bakgrunnsarbeid, lagre returnert ID og kontroller samme operasjon til den er ferdig. Et planlagt eller akseptert innlegg er først publisert når plattformen bekrefter det; et klienttidsavbrudd fastslår ikke resultatet.

Autentisering og tillatelser

Godtatte legitimasjonsklasser: user_session, delegated_oauth, personal_access_token
Delegert funksjon: agent:research
Minste arbeidsområderolle: editor
Tilgangsomfang: Ressurser denne brukeren er autorisert til å bruke
Samtykke for alle arbeidsområder kreves: Nei
Endrer tilstand: Ja
Når operasjonen er fullført: stable export identity and regenerated currently-authorized exact reviewed source content

Et token kan bare bruke rettighetene eieren har. Hver forespørsel kontrollerer arbeidsområdemedlemskap, ressurseierskap, valgte arbeidsområder og gitte funksjoner. Profilene core og full endrer hvilke verktøy som vises; de gir ikke tilgang.

Forespørselsfelter

Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.

Forespørselsfelter
Felt / gren	Type / påkrevd	Begrensninger
`$`	`object`Påkrevd i forelder	`additionalProperties: false`
`workspace_id`	`string`Påkrevd i forelder	`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`	`string`Påkrevd i forelder	`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)$"`
`brief_id`	`string`Påkrevd i forelder	`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)$"`
`brief_revision`	`integer`Påkrevd i forelder	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`variant_id`	`string \| null`Valgfritt / element	`default: null`
`variant_id`anyOf 1	`string`Valgfritt / element	`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)$"`
`variant_id`anyOf 2	`null`Valgfritt / element	—
`variant_revision`	`integer \| null`Valgfritt / element	`default: null`
`variant_revision`anyOf 1	`integer`Valgfritt / element	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`variant_revision`anyOf 2	`null`Valgfritt / element	—

Fullstendig 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)$"
    },
    "brief_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)$"
    },
    "brief_revision": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "variant_id": {
      "default": null,
      "anyOf": [
        {
          "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)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "variant_revision": {
      "default": null,
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "workspace_id",
    "mutation_id",
    "brief_id",
    "brief_revision"
  ],
  "additionalProperties": false
}

Svar og fullføring

HTTP-statuser ved suksess: 200. Når operasjonen er fullført: stable export identity and regenerated currently-authorized exact reviewed source content.

Påkrevd betyr påkrevd i foreldreobjektet og valgt gren. Et påkrevd underfelt gjør ikke en valgfri forelder påkrevd. Reglene og feltnavnene nedenfor er kopiert fra kontrakten.

Svar og fullføring
Felt / gren	Type / påkrevd	Begrensninger
`$`	`object`Påkrevd i forelder	—
`export`	`object`Påkrevd i forelder	—
`export.id`	`string`Påkrevd i forelder	`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)$"`
`export.workspace_id`	`string`Påkrevd i forelder	`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)$"`
`export.brief_id`	`string`Påkrevd i forelder	`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)$"`
`export.brief_revision`	`integer`Påkrevd i forelder	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`export.variant`	`object \| null`Påkrevd i forelder	—
`export.variant`anyOf 1	`object`Påkrevd i forelder	—
`export.variant.id`anyOf 1	`string`Påkrevd i forelder	`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)$"`
`export.variant.revision`anyOf 1	`integer`Påkrevd i forelder	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`export.variant.locale`anyOf 1	`string`Påkrevd i forelder	`enum: ["en","zh-HK"]`
`export.variant`anyOf 2	`null`Påkrevd i forelder	—
`export.created_at`	`string`Påkrevd i forelder	`format: "date-time"` `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)))$"`
`export.availability`	`string`Påkrevd i forelder	`enum: ["available","stale","unavailable"]`
`export.reasons`	`array`Påkrevd i forelder	`maxItems: 6`
`export.reasons[]`	`string`Valgfritt / element	`enum: ["source_unavailable","source_changed","brief_changed","variant_changed","draft_changed","draft_unavailable","not_reviewed"]`
`export.filename`	`string`Påkrevd i forelder	`maxLength: 100`
`export.media_type`	`string`Påkrevd i forelder	`const: "text/markdown"`
`export.text`	`string \| null`Påkrevd i forelder	—
`export.text`anyOf 1	`string`Påkrevd i forelder	`maxLength: 3000000`
`export.text`anyOf 2	`null`Påkrevd i forelder	—

Fullstendig JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "export": {
      "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)$"
        },
        "brief_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)$"
        },
        "brief_revision": {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "variant": {
          "anyOf": [
            {
              "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)$"
                },
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "locale": {
                  "type": "string",
                  "enum": [
                    "en",
                    "zh-HK"
                  ]
                }
              },
              "required": [
                "id",
                "revision",
                "locale"
              ]
            },
            {
              "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"
        },
        "availability": {
          "type": "string",
          "enum": [
            "available",
            "stale",
            "unavailable"
          ]
        },
        "reasons": {
          "maxItems": 6,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "source_unavailable",
              "source_changed",
              "brief_changed",
              "variant_changed",
              "draft_changed",
              "draft_unavailable",
              "not_reviewed"
            ]
          }
        },
        "filename": {
          "type": "string",
          "maxLength": 100
        },
        "media_type": {
          "type": "string",
          "const": "text/markdown"
        },
        "text": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 3000000
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "workspace_id",
        "brief_id",
        "brief_revision",
        "variant",
        "created_at",
        "availability",
        "reasons",
        "filename",
        "media_type",
        "text"
      ]
    }
  },
  "required": [
    "export"
  ]
}

Feil og trygge nye forsøk

Kontroller HTTP-status og svarinnhold. En 400-valideringsfeil kan inneholde en ZodError; håndteringsfeil bruker feltene error, message og code. Behold request_id eller x-request-id for feilsøking, uten påloggingsopplysninger. Rett 401/403-tilgangsfeil før nye forsøk, og følg Retry-After ved 429. Hvis en skriveoperasjon er usikker eller returnerer 5xx, les det eksisterende resultatet først. Gjenbruk bare en idempotensnøkkel der det støttes; virkemåten ved nye forsøk varierer mellom operasjoner og garanterer ikke levering nøyaktig én gang.

Feilsøkingsveiledning

Eksempler

Disse eksemplene bruker fiktive verdier kontrollert mot skjemaene. Erstatt ID-ene med noen du har lov til å bruke, mediene med klare ressurser og datoene med bekreftet publiseringstidspunkt. Kontroller kontoens kvalifikasjon før en skriveoperasjon sendes inn. Siden sender ingen API-forespørsler.

Angi SOSOAPI_ACCESS_TOKEN på serveren din til legitimasjon som operasjonen godtar, og hold den unna nettleserkode. For en KI-agent, bruk sosoapi auth login for innlogging gjennom nettleseren, og la CLI-et fornye legitimasjonen.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "brief_id": "30000000-0000-4000-8000-000000000003",
  "brief_revision": 1,
  "variant_id": null,
  "variant_revision": null,
  "mutation_id": "40000000-0000-4000-8000-000000000002"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/briefs/export" \
  -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/research-api/briefs/export", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "brief_id": "30000000-0000-4000-8000-000000000003",
  "brief_revision": 1,
  "variant_id": null,
  "variant_revision": null,
  "mutation_id": "40000000-0000-4000-8000-000000000002"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /research-api/briefs/export < request.json

Syntetisk svareksempel

{
  "export": {
    "id": "30000000-0000-4000-8000-000000000008",
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "brief_id": "30000000-0000-4000-8000-000000000003",
    "brief_revision": 1,
    "variant": null,
    "created_at": "2099-01-15T09:00:00Z",
    "availability": "unavailable",
    "reasons": [
      "source_unavailable"
    ],
    "filename": "research-brief-30000000-0000-4000-8000-000000000003.md",
    "media_type": "text/markdown",
    "text": null
  }
}

MCP: sosoapi_research_briefs_export

Alle API-operasjoner Autentisering og tillatelser

Personvernvalg

Nødvendige funksjoner

Valgfri bruksanalyse

Tillat også øktopptak på dette offentlige nettstedet

Eksporter et gjennomgått forskningsnotat med kildehenvisninger

Oversikt

Autentisering og tillatelser

Forespørselsfelter

Svar og fullføring

Feil og trygge nye forsøk

Eksempler

request.json

cURL

JavaScript

CLI

Syntetisk svareksempel

Eksporter et gjennomgått forskningsnotat med kildehenvisninger

Oversikt

Autentisering og tillatelser

Forespørselsfelter

Svar og fullføring

Feil og trygge nye forsøk

Eksempler

request.json

cURL

JavaScript

CLI

Syntetisk svareksempel

Relaterte verktøy og veiledninger