Privacyvoorkeuren

Noodzakelijke functies

Vereist voor beveiliging en de basisfuncties van de website.

Altijd actief

Optionele gebruiksanalyse

PostHog-gebruiksanalyse toestaan? Je kunt je keuze altijd in de voettekst wijzigen.

Ook sessiereplay op deze openbare website toestaan

Replay toont openbare pagina’s en interacties, waarbij invoer en privé-inhoud worden gemaskeerd. App-replay is een afzonderlijke keuze.

Vereist analyses; websiteherhaling staat standaard uit.

Browseranalyses schakelen accountanalyses niet in.

Zoeken wordt pas geladen wanneer je het gebruikt. Bekijk hieronder alle categorieën.

Research en briefings met bronverwijzingen

Ophalen van een openbare bron annuleren

Een wachtende ophaalactie annuleren op mutation_id, ook voordat toelating antwoordt; late inhoud kan niet worden vastgelegd. Vereist agent:research.

POST /research-api/evidence/cancel

Contract beoordeeld: · sha256:ab393e91e9b7f18a

Overzicht

Een wachtende ophaalactie annuleren op mutation_id, ook voordat toelating antwoordt; late inhoud kan niet worden vastgelegd. Vereist agent:research.

Een geslaagd HTTP-antwoord kan acceptatie betekenen in plaats van voltooiing. Bewaar bij achtergrondwerk de teruggegeven ID en controleer dezelfde bewerking totdat die klaar is. Een ingepland of geaccepteerd bericht is pas gepubliceerd na platformbevestiging; een client-time-out bepaalt het resultaat niet.

Authenticatie en machtigingen

Toegestane soorten inloggegevens
user_session, delegated_oauth, personal_access_token
Gedelegeerde bevoegdheid
agent:research
Minimale werkruimterol
editor
Toegangsbereik
Resources waartoe deze gebruiker toegang heeft
Toestemming voor alle werkruimten vereist
Nee
Wijzigt status
Ja
Wanneer de bewerking voltooid is
committed cancellation fence; late reader output is discarded

Een token kan alleen rechten van de eigenaar gebruiken. Elk verzoek controleert werkruimtelidmaatschap, resource-eigendom, geselecteerde werkruimten en verleende bevoegdheden. De profielen core en full bepalen welke tools zichtbaar zijn; ze verlenen geen toegang.

Verzoekvelden

Verplicht betekent verplicht binnen het bovenliggende object en de gekozen variant. Een verplicht onderliggend veld maakt een optioneel bovenliggend object niet verplicht. Onderstaande regels en veldnamen zijn uit het contract gekopieerd.

Verzoekvelden
Veld / variantType / verplichtBeperkingen
$objectVerplicht in bovenliggend object
  • additionalProperties: false
workspace_idstringVerplicht in bovenliggend object
  • 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_idstringVerplicht in bovenliggend object
  • 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)$"
Volledig 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)$"
    }
  },
  "required": [
    "workspace_id",
    "mutation_id"
  ],
  "additionalProperties": false
}

Antwoord en voltooiing

HTTP-statuscodes bij succes: 200. Wanneer de bewerking voltooid is: committed cancellation fence; late reader output is discarded.

Een geslaagd HTTP-antwoord kan acceptatie betekenen in plaats van voltooiing. Bewaar bij achtergrondwerk de teruggegeven ID en controleer dezelfde bewerking totdat die klaar is. Een ingepland of geaccepteerd bericht is pas gepubliceerd na platformbevestiging; een client-time-out bepaalt het resultaat niet.

Verplicht betekent verplicht binnen het bovenliggende object en de gekozen variant. Een verplicht onderliggend veld maakt een optioneel bovenliggend object niet verplicht. Onderstaande regels en veldnamen zijn uit het contract gekopieerd.

Antwoord en voltooiing
Veld / variantType / verplichtBeperkingen
$objectVerplicht in bovenliggend object—
retrievalobjectVerplicht in bovenliggend object—
retrieval.idstringVerplicht in bovenliggend object
  • 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)$"
retrieval.workspace_idstringVerplicht in bovenliggend object
  • 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)$"
retrieval.mutation_idstringVerplicht in bovenliggend object
  • 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)$"
retrieval.statestringVerplicht in bovenliggend object
  • enum: ["pending","running","completed","cancelled","unconfirmed","expired"]
retrieval.kindstring | nullVerplicht in bovenliggend object—
retrieval.kindanyOf 1stringVerplicht in bovenliggend object
  • enum: ["url_text","published_captions"]
retrieval.kindanyOf 2nullVerplicht in bovenliggend object—
retrieval.created_atstringVerplicht in bovenliggend object
  • 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)))$"
retrieval.settled_atstring | nullVerplicht in bovenliggend object—
retrieval.settled_atanyOf 1stringVerplicht in bovenliggend object
  • 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)))$"
retrieval.settled_atanyOf 2nullVerplicht in bovenliggend object—
retrieval.valid_untilstringVerplicht in bovenliggend object
  • 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)))$"
retrieval.resultobject | nullVerplicht in bovenliggend object—
retrieval.resultanyOf 1objectVerplicht in bovenliggend object—
retrieval.result.kindanyOf 1stringVerplicht in bovenliggend object
  • enum: ["url_text","published_captions"]
retrieval.result.statusanyOf 1stringVerplicht in bovenliggend object
  • enum: ["ready","partial","blocked","unsupported","empty","rate_limited","unavailable","cancelled"]
retrieval.result.textanyOf 1stringVerplicht in bovenliggend object
  • maxLength: 20000
retrieval.result.titleanyOf 1string | nullVerplicht in bovenliggend object—
retrieval.result.titleanyOf 1 / anyOf 1stringVerplicht in bovenliggend object
  • minLength: 1
  • maxLength: 200
retrieval.result.titleanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
retrieval.result.descriptionanyOf 1string | nullVerplicht in bovenliggend object—
retrieval.result.descriptionanyOf 1 / anyOf 1stringVerplicht in bovenliggend object
  • minLength: 1
  • maxLength: 2000
retrieval.result.descriptionanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
retrieval.result.segmentsanyOf 1arrayVerplicht in bovenliggend object
  • maxItems: 1000
retrieval.result.segments[]anyOf 1objectOptioneel / item—
retrieval.result.segments[].start_msanyOf 1integerVerplicht in bovenliggend object
  • minimum: 0
  • maximum: 9007199254740991
retrieval.result.segments[].end_msanyOf 1integerVerplicht in bovenliggend object
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
retrieval.result.segments[].textanyOf 1stringVerplicht in bovenliggend object
  • minLength: 1
  • maxLength: 20000
retrieval.result.provenanceanyOf 1objectVerplicht in bovenliggend object—
retrieval.result.provenance.source_urlanyOf 1string | nullVerplicht in bovenliggend object—
retrieval.result.provenance.source_urlanyOf 1 / anyOf 1stringVerplicht in bovenliggend object
  • format: "uri"
  • maxLength: 2048
retrieval.result.provenance.source_urlanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
retrieval.result.provenance.retrieved_atanyOf 1stringVerplicht in bovenliggend object
  • 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)))$"
retrieval.result.provenance.mime_typeanyOf 1string | nullVerplicht in bovenliggend object—
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 1stringVerplicht in bovenliggend object
  • enum: ["text/html","application/xhtml+xml","text/plain","text/vtt","application/x-subrip","application/srt","text/srt"]
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
retrieval.result.provenance.parser_versionanyOf 1stringVerplicht in bovenliggend object
  • const: "research-public-retrieval/v1"
retrieval.result.provenance.content_kindanyOf 1stringVerplicht in bovenliggend object
  • enum: ["document_text","metadata_only","published_caption_file","none"]
retrieval.result.provenance.caption_formatanyOf 1string | nullVerplicht in bovenliggend object—
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 1stringVerplicht in bovenliggend object
  • enum: ["webvtt","subrip"]
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
retrieval.result.provenance.languageanyOf 1string | nullVerplicht in bovenliggend object—
retrieval.result.provenance.languageanyOf 1 / anyOf 1stringVerplicht in bovenliggend object
  • minLength: 1
  • maxLength: 35
  • pattern: "^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$"
retrieval.result.provenance.languageanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
retrieval.result.provenance.language_sourceanyOf 1stringVerplicht in bovenliggend object
  • enum: ["publisher_declared","unknown"]
retrieval.result.provenance.platform_native_verifiedanyOf 1booleanVerplicht in bovenliggend object
  • const: false
retrieval.result.reasonanyOf 1string | nullVerplicht in bovenliggend object—
retrieval.result.reasonanyOf 1 / anyOf 1stringVerplicht in bovenliggend object
  • enum: ["unsafe_url","unsupported_source","unsupported_media","unsupported_content","access_denied","login_required","no_text","metadata_only","no_captions","invalid_captions","not_found","rate_limited","response_too_large","text_limited","nodes_limited","cues_limited","invalid_cues","language_mismatch","source_partial","timeout","cancelled","egress_unavailable","unavailable"]
retrieval.result.reasonanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
retrieval.result.warningsanyOf 1arrayVerplicht in bovenliggend object
  • maxItems: 10
retrieval.result.warnings[]anyOf 1stringOptioneel / item
  • enum: ["unsafe_url","unsupported_source","unsupported_media","unsupported_content","access_denied","login_required","no_text","metadata_only","no_captions","invalid_captions","not_found","rate_limited","response_too_large","text_limited","nodes_limited","cues_limited","invalid_cues","language_mismatch","source_partial","timeout","cancelled","egress_unavailable","unavailable"]
retrieval.result.retry_after_secondsanyOf 1integer | nullVerplicht in bovenliggend object—
retrieval.result.retry_after_secondsanyOf 1 / anyOf 1integerVerplicht in bovenliggend object
  • minimum: 1
  • maximum: 86400
retrieval.result.retry_after_secondsanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
retrieval.resultanyOf 2nullVerplicht in bovenliggend object—
retrieval.evidenceobject | nullVerplicht in bovenliggend object—
retrieval.evidenceanyOf 1objectVerplicht in bovenliggend object—
retrieval.evidence.evidence_idanyOf 1stringVerplicht in bovenliggend object
  • 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)$"
retrieval.evidence.revisionanyOf 1integerVerplicht in bovenliggend object
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
retrieval.evidenceanyOf 2nullVerplicht in bovenliggend object—
Volledig JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "retrieval": {
      "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)$"
        },
        "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)$"
        },
        "state": {
          "type": "string",
          "enum": [
            "pending",
            "running",
            "completed",
            "cancelled",
            "unconfirmed",
            "expired"
          ]
        },
        "kind": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "url_text",
                "published_captions"
              ]
            },
            {
              "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"
        },
        "settled_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"
            }
          ]
        },
        "valid_until": {
          "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"
        },
        "result": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "url_text",
                    "published_captions"
                  ]
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "ready",
                    "partial",
                    "blocked",
                    "unsupported",
                    "empty",
                    "rate_limited",
                    "unavailable",
                    "cancelled"
                  ]
                },
                "text": {
                  "type": "string",
                  "maxLength": 20000
                },
                "title": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "description": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "segments": {
                  "maxItems": 1000,
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "start_ms": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      "end_ms": {
                        "type": "integer",
                        "exclusiveMinimum": 0,
                        "maximum": 9007199254740991
                      },
                      "text": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 20000
                      }
                    },
                    "required": [
                      "start_ms",
                      "end_ms",
                      "text"
                    ]
                  }
                },
                "provenance": {
                  "type": "object",
                  "properties": {
                    "source_url": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 2048,
                          "format": "uri"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "retrieved_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"
                    },
                    "mime_type": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "text/html",
                            "application/xhtml+xml",
                            "text/plain",
                            "text/vtt",
                            "application/x-subrip",
                            "application/srt",
                            "text/srt"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "parser_version": {
                      "type": "string",
                      "const": "research-public-retrieval/v1"
                    },
                    "content_kind": {
                      "type": "string",
                      "enum": [
                        "document_text",
                        "metadata_only",
                        "published_caption_file",
                        "none"
                      ]
                    },
                    "caption_format": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "webvtt",
                            "subrip"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "language": {
                      "anyOf": [
                        {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 35,
                          "pattern": "^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "language_source": {
                      "type": "string",
                      "enum": [
                        "publisher_declared",
                        "unknown"
                      ]
                    },
                    "platform_native_verified": {
                      "type": "boolean",
                      "const": false
                    }
                  },
                  "required": [
                    "source_url",
                    "retrieved_at",
                    "mime_type",
                    "parser_version",
                    "content_kind",
                    "caption_format",
                    "language",
                    "language_source",
                    "platform_native_verified"
                  ]
                },
                "reason": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "unsafe_url",
                        "unsupported_source",
                        "unsupported_media",
                        "unsupported_content",
                        "access_denied",
                        "login_required",
                        "no_text",
                        "metadata_only",
                        "no_captions",
                        "invalid_captions",
                        "not_found",
                        "rate_limited",
                        "response_too_large",
                        "text_limited",
                        "nodes_limited",
                        "cues_limited",
                        "invalid_cues",
                        "language_mismatch",
                        "source_partial",
                        "timeout",
                        "cancelled",
                        "egress_unavailable",
                        "unavailable"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "warnings": {
                  "maxItems": 10,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "unsafe_url",
                      "unsupported_source",
                      "unsupported_media",
                      "unsupported_content",
                      "access_denied",
                      "login_required",
                      "no_text",
                      "metadata_only",
                      "no_captions",
                      "invalid_captions",
                      "not_found",
                      "rate_limited",
                      "response_too_large",
                      "text_limited",
                      "nodes_limited",
                      "cues_limited",
                      "invalid_cues",
                      "language_mismatch",
                      "source_partial",
                      "timeout",
                      "cancelled",
                      "egress_unavailable",
                      "unavailable"
                    ]
                  }
                },
                "retry_after_seconds": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 86400
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "kind",
                "status",
                "text",
                "title",
                "description",
                "segments",
                "provenance",
                "reason",
                "warnings",
                "retry_after_seconds"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "evidence": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "evidence_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
                }
              },
              "required": [
                "evidence_id",
                "revision"
              ]
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "workspace_id",
        "mutation_id",
        "state",
        "kind",
        "created_at",
        "settled_at",
        "valid_until",
        "result",
        "evidence"
      ]
    }
  },
  "required": [
    "retrieval"
  ]
}

Fouten en veilig opnieuw proberen

Controleer de HTTP-status en antwoordinhoud. Een 400-validatiefout kan een ZodError bevatten; afhandelingsfouten gebruiken de velden error, message en code. Bewaar request_id of x-request-id voor diagnose, zonder inloggegevens. Los 401/403-toegangsfouten op voordat je opnieuw probeert en volg Retry-After bij 429. Lees bij een onzekere schrijfhandeling of 5xx eerst het bestaande resultaat. Hergebruik een idempotentiesleutel alleen waar dit wordt ondersteund; het gedrag bij opnieuw proberen verschilt per bewerking en garandeert geen precies eenmalige aflevering.

Handleiding voor probleemoplossing

Voorbeelden

Deze voorbeelden gebruiken fictieve waarden die tegen de schema's zijn gecontroleerd. Vervang IDs door toegestane IDs, media door gereedstaande bestanden en datums door je bevestigde publicatietijd. Controleer accountgeschiktheid vóór een schrijfhandeling. Deze pagina verstuurt geen API-verzoeken.

Stel SOSOAPI_ACCESS_TOKEN op je server in op inloggegevens die deze bewerking accepteert en houd deze uit browsercode. Gebruik voor een AI-agent sosoapi auth login om via de browser aan te melden en laat de CLI de inloggegevens vernieuwen.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "mutation_id": "40000000-0000-4000-8000-000000000001"
}

cURL

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

CLI

npx sosoapi api post /research-api/evidence/cancel < request.json

Voorbeeld van een synthetisch antwoord

{
  "retrieval": {
    "id": "30000000-0000-4000-8000-000000000007",
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "mutation_id": "40000000-0000-4000-8000-000000000001",
    "state": "cancelled",
    "kind": "url_text",
    "created_at": "2099-01-15T09:00:00Z",
    "settled_at": "2099-01-15T09:00:01Z",
    "valid_until": "2099-01-16T09:00:00Z",
    "evidence": null,
    "result": null
  }
}

MCP: sosoapi_research_evidence_cancel