Media en bestanden

Mediabestanden weergeven

Toon de mediabestanden van een werkruimte, gefilterd op type (video, image, audio, cover, thumbnail, frame, video-source, branding) of customer_ready_only, met next_offset-paginering. workspace_id is verplicht.

POST /assets-api/list-workspace

Contract beoordeeld: 2026-10-21 · sha256:563d2d581da0ad29

Lezen als Markdown Download openbaar contract Download OpenAPI

Overzicht

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 / variant	Type / verplicht	Beperkingen
`$`	`object`Verplicht in bovenliggend object	—
`workspace_id`	`string`Verplicht 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)$"`
`kind`	`string`Optioneel / item	`enum: ["video","image","audio","cover","thumbnail","frame","video-source","branding"]`
`customer_ready_only`	`boolean`Optioneel / item	`default: false`
`limit`	`integer`Optioneel / item	`minimum: 1` `maximum: 100` `default: 24`
`offset`	`integer`Optioneel / item	Over te slaan rijen. Beschikbaar tot 100000; daarboven 400 OFFSET_TOO_LARGE. `minimum: 0` `maximum: 9007199254740991` `default: 0`

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)$"
    },
    "kind": {
      "type": "string",
      "enum": [
        "video",
        "image",
        "audio",
        "cover",
        "thumbnail",
        "frame",
        "video-source",
        "branding"
      ]
    },
    "customer_ready_only": {
      "default": false,
      "type": "boolean"
    },
    "limit": {
      "default": 24,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Rows to skip. Served up to 100000; beyond it 400 OFFSET_TOO_LARGE.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "workspace_id"
  ]
}

Antwoord en voltooiing

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

Antwoord en voltooiing
Veld / variant	Type / verplicht	Beperkingen
`$`	`object`Verplicht in bovenliggend object	—
`assets`	`array`Verplicht in bovenliggend object	—
`assets[]`	`object`Optioneel / item	—
`assets[].id`	`integer \| string`Verplicht in bovenliggend object	—
`assets[].id`anyOf 1	`integer`Verplicht in bovenliggend object	`minimum: -9007199254740991` `maximum: 9007199254740991`
`assets[].id`anyOf 2	`string`Verplicht in bovenliggend object	—
`assets[].asset_type`	`string`Verplicht in bovenliggend object	`enum: ["text","image","video","audio"]`
`assets[].asset_url`	`string \| null`Verplicht in bovenliggend object	—
`assets[].asset_url`anyOf 1	`string`Verplicht in bovenliggend object	`format: "uri"`
`assets[].asset_url`anyOf 2	`null`Verplicht in bovenliggend object	—
`assets[].preview_url`	`string \| null`Optioneel / item	Tijdelijke lees-URL met werkruimtetoestemming. Vernieuw via Asset lezen/weergeven na preview_expires_at; behoud asset_url als blijvende media-identiteit. —
`assets[].preview_url`anyOf 1	`string`Optioneel / item	`format: "uri"`
`assets[].preview_url`anyOf 2	`null`Optioneel / item	—
`assets[].preview_expires_at`	`string \| null`Optioneel / item	—
`assets[].preview_expires_at`anyOf 1	`string`Optioneel / item	`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))$"`
`assets[].preview_expires_at`anyOf 2	`null`Optioneel / item	—
`assets[].title`	`string \| null`Verplicht in bovenliggend object	—
`assets[].title`anyOf 1	`string`Verplicht in bovenliggend object	—
`assets[].title`anyOf 2	`null`Verplicht in bovenliggend object	—
`assets[].description`	`string \| null`Verplicht in bovenliggend object	—
`assets[].description`anyOf 1	`string`Verplicht in bovenliggend object	—
`assets[].description`anyOf 2	`null`Verplicht in bovenliggend object	—
`assets[].tags`	`array \| null`Verplicht in bovenliggend object	—
`assets[].tags`anyOf 1	`array`Verplicht in bovenliggend object	—
`assets[].tags[]`anyOf 1	`string`Optioneel / item	—
`assets[].tags`anyOf 2	`null`Verplicht in bovenliggend object	—
`assets[].created_at`	`string`Verplicht 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)))$"`
`assets[].readiness`	`object`Verplicht in bovenliggend object	—
`assets[].readiness.status`	`string`Verplicht in bovenliggend object	`enum: ["ready","not_ready"]`
`assets[].readiness.reason_code`	`string`Verplicht in bovenliggend object	`enum: ["ready","unsupported_kind","missing_registered_media","untrusted_workspace_object","media_probe_missing_or_invalid"]`
`assets[].readiness.message`	`string`Verplicht in bovenliggend object	`minLength: 1` `maxLength: 500`
`total`	`integer`Verplicht in bovenliggend object	`minimum: 0` `maximum: 9007199254740991`
`next_offset`	`integer \| null`Verplicht in bovenliggend object	—
`next_offset`anyOf 1	`integer`Verplicht in bovenliggend object	`minimum: 0` `maximum: 9007199254740991`
`next_offset`anyOf 2	`null`Verplicht in bovenliggend object	—

Volledig JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "assets": {
      "type": "array",
      "items": {
        "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",
                "format": "uri"
              },
              {
                "type": "null"
              }
            ]
          },
          "preview_url": {
            "description": "Workspace-authorized temporary read URL. Refresh through Asset read/list after preview_expires_at; keep asset_url as persisted media identity.",
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "null"
              }
            ]
          },
          "preview_expires_at": {
            "anyOf": [
              {
                "type": "string",
                "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))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "title": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tags": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "type": "string",
            "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)))$"
          },
          "readiness": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string",
                "enum": [
                  "ready",
                  "not_ready"
                ]
              },
              "reason_code": {
                "type": "string",
                "enum": [
                  "ready",
                  "unsupported_kind",
                  "missing_registered_media",
                  "untrusted_workspace_object",
                  "media_probe_missing_or_invalid"
                ]
              },
              "message": {
                "type": "string",
                "minLength": 1,
                "maxLength": 500
              }
            },
            "required": [
              "status",
              "reason_code",
              "message"
            ]
          }
        },
        "required": [
          "id",
          "asset_type",
          "asset_url",
          "title",
          "description",
          "tags",
          "created_at",
          "readiness"
        ]
      }
    },
    "total": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "next_offset": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "assets",
    "total",
    "next_offset"
  ]
}

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"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/list-workspace" \
  -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/list-workspace", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_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/list-workspace < request.json

Voorbeeld van een synthetisch antwoord

{
  "assets": [],
  "total": 0,
  "next_offset": null
}

MCP: sosoapi_list_assets

Alle API-bewerkingen Authenticatie en machtigingen