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

Søk lastes bare når du bruker det. Bla gjennom alle kategoriene nedenfor.

Medier og ressurser

Hent importstatus for ressurs

Les en import etter import_id. Ved publisering, oppgi include_asset=true: et klart resultat inneholder registrert ressurs-ID, kind og stabil asset_url, så et separat get_asset ikke trengs. Ventende eller manglende ressurser kan ikke planlegges. Bruk aldri kilde- eller forhåndsvisnings-URL som medieidentitet. Hvis importen står fast, les sosoapi_job_status med job_id; start aldri en duplisert import.

POST /assets-api/imports/status

Kontrakt gjennomgått: · sha256:563d2d581da0ad29

Les som MarkdownLast ned offentlig kontraktLast ned OpenAPI

Oversikt

Les en import etter import_id. Ved publisering, oppgi include_asset=true: et klart resultat inneholder registrert ressurs-ID, kind og stabil asset_url, så et separat get_asset ikke trengs. Ventende eller manglende ressurser kan ikke planlegges. Bruk aldri kilde- eller forhåndsvisnings-URL som medieidentitet. Hvis importen står fast, les sosoapi_job_status med job_id; start aldri en duplisert import.

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:operate
Minste arbeidsområderolle
viewer
Tilgangsomfang
Ressurser denne brukeren er autorisert til å bruke
Samtykke for alle arbeidsområder kreves
Nei
Endrer tilstand
Nei
Når operasjonen er fullført
synchronous_http_response

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 / grenType / påkrevdBegrensninger
$objectPåkrevd i forelder
  • additionalProperties: false
workspace_idstringPå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)$"
import_idstringPå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)$"
include_assetbooleanValgfritt / 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)$"
    },
    "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
}

Svar og fullføring

HTTP-statuser ved suksess: 200. Når operasjonen er fullført: synchronous_http_response.

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.

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 / grenType / påkrevdBegrensninger
$objectPåkrevd i forelder—
importobjectPåkrevd i forelder—
import.idstringPå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)$"
import.statusstringPåkrevd i forelder
  • enum: ["queued","importing","needs_repair","ready","asset_purged","failed"]
import.job_idstring | nullPåkrevd i forelder—
import.job_idanyOf 1stringPå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)$"
import.job_idanyOf 2nullPåkrevd i forelder—
import.asset_idinteger | nullPåkrevd i forelder—
import.asset_idanyOf 1integerPåkrevd i forelder
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
import.asset_idanyOf 2nullPåkrevd i forelder—
import.completed_asset_idinteger | nullPåkrevd i forelder—
import.completed_asset_idanyOf 1integerPåkrevd i forelder
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
import.completed_asset_idanyOf 2nullPåkrevd i forelder—
import.asset_purged_atstring | nullPåkrevd i forelder—
import.asset_purged_atanyOf 1stringPåkrevd i forelder—
import.asset_purged_atanyOf 2nullPåkrevd i forelder—
import.source_urlstringPåkrevd i forelder
  • format: "uri"
import.final_urlstring | nullPåkrevd i forelder—
import.final_urlanyOf 1stringPåkrevd i forelder
  • format: "uri"
import.final_urlanyOf 2nullPåkrevd i forelder—
import.object_keystring | nullPåkrevd i forelder—
import.object_keyanyOf 1stringPåkrevd i forelder
  • minLength: 1
import.object_keyanyOf 2nullPåkrevd i forelder—
import.content_typestring | nullPåkrevd i forelder—
import.content_typeanyOf 1stringPåkrevd i forelder
  • minLength: 1
import.content_typeanyOf 2nullPåkrevd i forelder—
import.byte_sizeinteger | nullPåkrevd i forelder—
import.byte_sizeanyOf 1integerPåkrevd i forelder
  • minimum: 0
  • maximum: 9007199254740991
import.byte_sizeanyOf 2nullPåkrevd i forelder—
import.content_sha256string | nullPåkrevd i forelder—
import.content_sha256anyOf 1stringPåkrevd i forelder
  • pattern: "^[0-9a-f]{64}$"
import.content_sha256anyOf 2nullPåkrevd i forelder—
import.media_probereference | nullPåkrevd i forelder—
import.media_probeanyOf 1string | number | boolean | null | array | objectPåkrevd i forelder—
import.media_probeanyOf 1 / anyOf 1stringPåkrevd i forelder—
import.media_probeanyOf 1 / anyOf 2numberPåkrevd i forelder—
import.media_probeanyOf 1 / anyOf 3booleanPåkrevd i forelder—
import.media_probeanyOf 1 / anyOf 4nullPåkrevd i forelder—
import.media_probeanyOf 1 / anyOf 5arrayPåkrevd i forelder—
import.media_probe[]anyOf 1 / anyOf 5referenceValgfritt / element
  • #/$defs/__schema0
import.media_probeanyOf 1 / anyOf 6objectPåkrevd i forelder
  • additionalProperties: {"$ref":"#/$defs/__schema0"}
import.media_probe.*anyOf 1 / anyOf 6referenceValgfritt / element
  • #/$defs/__schema0
import.media_probeanyOf 2nullPåkrevd i forelder—
import.error_messagestring | nullPåkrevd i forelder—
import.error_messageanyOf 1stringPåkrevd i forelder—
import.error_messageanyOf 2nullPåkrevd i forelder—
import.created_atstringPåkrevd i forelder—
import.completed_atstring | nullPåkrevd i forelder—
import.completed_atanyOf 1stringPåkrevd i forelder—
import.completed_atanyOf 2nullPåkrevd i forelder—
assetobject | nullValgfritt / element—
assetanyOf 1objectValgfritt / element—
asset.idanyOf 1integer | stringPåkrevd i forelder—
asset.idanyOf 1 / anyOf 1integerPåkrevd i forelder
  • minimum: -9007199254740991
  • maximum: 9007199254740991
asset.idanyOf 1 / anyOf 2stringPåkrevd i forelder—
asset.asset_typeanyOf 1stringPåkrevd i forelder
  • enum: ["text","image","video","audio"]
asset.asset_urlanyOf 1string | nullPåkrevd i forelder—
asset.asset_urlanyOf 1 / anyOf 1stringPåkrevd i forelder—
asset.asset_urlanyOf 1 / anyOf 2nullPåkrevd i forelder—
assetanyOf 2nullValgfritt / element—
Fullstendig 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"
          }
        }
      ]
    }
  }
}

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 agent, bruk sosoapi auth login for innlogging gjennom nettleseren, og la CLI-et fornye legitimasjonen.

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

Syntetisk svareksempel

{
  "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-operasjonerAutentisering og tillatelser