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

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

Media en bestanden

Importstatus van mediabestand ophalen

Lees een import op import_id. Geef voor publicatie include_asset=true mee: een gereed resultaat bevat de geregistreerde media-id, het type en de stabiele asset_url, zodat een aparte get_asset niet nodig is. Wachtende of ontbrekende mediabestanden kunnen niet worden ingepland. Gebruik nooit de bron- of voorbeeld-URL als media-identiteit. Vraag bij stilstand sosoapi_job_status op met job_id; start nooit een dubbele import.

POST /assets-api/imports/status

Contract beoordeeld: · sha256:563d2d581da0ad29

Lezen als MarkdownDownload openbaar contractDownload OpenAPI

Overzicht

Lees een import op import_id. Geef voor publicatie include_asset=true mee: een gereed resultaat bevat de geregistreerde media-id, het type en de stabiele asset_url, zodat een aparte get_asset niet nodig is. Wachtende of ontbrekende mediabestanden kunnen niet worden ingepland. Gebruik nooit de bron- of voorbeeld-URL als media-identiteit. Vraag bij stilstand sosoapi_job_status op met job_id; start nooit een dubbele import.

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:operate
Minimale werkruimterol
viewer
Toegangsbereik
Resources waartoe deze gebruiker toegang heeft
Toestemming voor alle werkruimten vereist
Nee
Wijzigt status
Nee
Wanneer de bewerking voltooid is
synchronous_http_response

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)$"
import_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)$"
include_assetbooleanOptioneel / item—
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)$"
    },
    "import_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)$"
    },
    "include_asset": {
      "type": "boolean"
    }
  },
  "required": [
    "workspace_id",
    "import_id"
  ],
  "additionalProperties": false
}

Antwoord en voltooiing

HTTP-statuscodes bij succes: 200. Wanneer de bewerking voltooid is: synchronous_http_response.

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—
importobjectVerplicht in bovenliggend object—
import.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)$"
import.statusstringVerplicht in bovenliggend object
  • enum: ["queued","importing","needs_repair","ready","asset_purged","failed"]
import.job_idstring | nullVerplicht in bovenliggend object—
import.job_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)$"
import.job_idanyOf 2nullVerplicht in bovenliggend object—
import.asset_idinteger | nullVerplicht in bovenliggend object—
import.asset_idanyOf 1integerVerplicht in bovenliggend object
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
import.asset_idanyOf 2nullVerplicht in bovenliggend object—
import.completed_asset_idinteger | nullVerplicht in bovenliggend object—
import.completed_asset_idanyOf 1integerVerplicht in bovenliggend object
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
import.completed_asset_idanyOf 2nullVerplicht in bovenliggend object—
import.asset_purged_atstring | nullVerplicht in bovenliggend object—
import.asset_purged_atanyOf 1stringVerplicht in bovenliggend object—
import.asset_purged_atanyOf 2nullVerplicht in bovenliggend object—
import.source_urlstringVerplicht in bovenliggend object
  • format: "uri"
import.final_urlstring | nullVerplicht in bovenliggend object—
import.final_urlanyOf 1stringVerplicht in bovenliggend object
  • format: "uri"
import.final_urlanyOf 2nullVerplicht in bovenliggend object—
import.object_keystring | nullVerplicht in bovenliggend object—
import.object_keyanyOf 1stringVerplicht in bovenliggend object
  • minLength: 1
import.object_keyanyOf 2nullVerplicht in bovenliggend object—
import.content_typestring | nullVerplicht in bovenliggend object—
import.content_typeanyOf 1stringVerplicht in bovenliggend object
  • minLength: 1
import.content_typeanyOf 2nullVerplicht in bovenliggend object—
import.byte_sizeinteger | nullVerplicht in bovenliggend object—
import.byte_sizeanyOf 1integerVerplicht in bovenliggend object
  • minimum: 0
  • maximum: 9007199254740991
import.byte_sizeanyOf 2nullVerplicht in bovenliggend object—
import.content_sha256string | nullVerplicht in bovenliggend object—
import.content_sha256anyOf 1stringVerplicht in bovenliggend object
  • pattern: "^[0-9a-f]{64}$"
import.content_sha256anyOf 2nullVerplicht in bovenliggend object—
import.media_probereference | nullVerplicht in bovenliggend object—
import.media_probeanyOf 1string | number | boolean | null | array | objectVerplicht in bovenliggend object—
import.media_probeanyOf 1 / anyOf 1stringVerplicht in bovenliggend object—
import.media_probeanyOf 1 / anyOf 2numberVerplicht in bovenliggend object—
import.media_probeanyOf 1 / anyOf 3booleanVerplicht in bovenliggend object—
import.media_probeanyOf 1 / anyOf 4nullVerplicht in bovenliggend object—
import.media_probeanyOf 1 / anyOf 5arrayVerplicht in bovenliggend object—
import.media_probe[]anyOf 1 / anyOf 5referenceOptioneel / item
  • #/$defs/__schema0
import.media_probeanyOf 1 / anyOf 6objectVerplicht in bovenliggend object
  • additionalProperties: {"$ref":"#/$defs/__schema0"}
import.media_probe.*anyOf 1 / anyOf 6referenceOptioneel / item
  • #/$defs/__schema0
import.media_probeanyOf 2nullVerplicht in bovenliggend object—
import.error_messagestring | nullVerplicht in bovenliggend object—
import.error_messageanyOf 1stringVerplicht in bovenliggend object—
import.error_messageanyOf 2nullVerplicht in bovenliggend object—
import.created_atstringVerplicht in bovenliggend object—
import.completed_atstring | nullVerplicht in bovenliggend object—
import.completed_atanyOf 1stringVerplicht in bovenliggend object—
import.completed_atanyOf 2nullVerplicht in bovenliggend object—
assetobject | nullOptioneel / item—
assetanyOf 1objectOptioneel / item—
asset.idanyOf 1integer | stringVerplicht in bovenliggend object—
asset.idanyOf 1 / anyOf 1integerVerplicht in bovenliggend object
  • minimum: -9007199254740991
  • maximum: 9007199254740991
asset.idanyOf 1 / anyOf 2stringVerplicht in bovenliggend object—
asset.asset_typeanyOf 1stringVerplicht in bovenliggend object
  • enum: ["text","image","video","audio"]
asset.asset_urlanyOf 1string | nullVerplicht in bovenliggend object—
asset.asset_urlanyOf 1 / anyOf 1stringVerplicht in bovenliggend object—
asset.asset_urlanyOf 1 / anyOf 2nullVerplicht in bovenliggend object—
assetanyOf 2nullOptioneel / item—
Volledig JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "import": {
      "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)$"
        },
        "status": {
          "type": "string",
          "enum": [
            "queued",
            "importing",
            "needs_repair",
            "ready",
            "asset_purged",
            "failed"
          ]
        },
        "job_id": {
          "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"
            }
          ]
        },
        "asset_id": {
          "anyOf": [
            {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        },
        "completed_asset_id": {
          "anyOf": [
            {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        },
        "asset_purged_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "source_url": {
          "type": "string",
          "format": "uri"
        },
        "final_url": {
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "null"
            }
          ]
        },
        "object_key": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1
            },
            {
              "type": "null"
            }
          ]
        },
        "content_type": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1
            },
            {
              "type": "null"
            }
          ]
        },
        "byte_size": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        },
        "content_sha256": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "media_probe": {
          "anyOf": [
            {
              "$ref": "#/$defs/__schema0"
            },
            {
              "type": "null"
            }
          ]
        },
        "error_message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "created_at": {
          "type": "string"
        },
        "completed_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "status",
        "job_id",
        "asset_id",
        "completed_asset_id",
        "asset_purged_at",
        "source_url",
        "final_url",
        "object_key",
        "content_type",
        "byte_size",
        "content_sha256",
        "media_probe",
        "error_message",
        "created_at",
        "completed_at"
      ]
    },
    "asset": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "anyOf": [
                {
                  "type": "integer",
                  "minimum": -9007199254740991,
                  "maximum": 9007199254740991
                },
                {
                  "type": "string"
                }
              ]
            },
            "asset_type": {
              "type": "string",
              "enum": [
                "text",
                "image",
                "video",
                "audio"
              ]
            },
            "asset_url": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "id",
            "asset_type",
            "asset_url"
          ]
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "import"
  ],
  "$defs": {
    "__schema0": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/__schema0"
          }
        },
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "$ref": "#/$defs/__schema0"
          }
        }
      ]
    }
  }
}

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 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",
  "import_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/imports/status" \
  -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/assets-api/imports/status", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "import_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 /assets-api/imports/status < request.json

Voorbeeld van een synthetisch antwoord

{
  "import": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "queued",
    "job_id": null,
    "asset_id": null,
    "completed_asset_id": null,
    "asset_purged_at": null,
    "source_url": "https://example.com/media.png",
    "final_url": null,
    "object_key": null,
    "content_type": null,
    "byte_size": null,
    "content_sha256": null,
    "media_probe": null,
    "error_message": null,
    "created_at": "example",
    "completed_at": null
  }
}

MCP: sosoapi_get_asset_import_status

Alle API-bewerkingenAuthenticatie en machtigingen