Medier og ressurser

Vis ressurser

Vis ressurser i et arbeidsområde filtrert etter kind (video, image, audio, cover, thumbnail, frame, video-source, branding) eller customer_ready_only, med next_offset-paginering. workspace_id kreves.

POST /assets-api/list-workspace

Kontrakt gjennomgått: 2026-10-21 · sha256:563d2d581da0ad29

Les som Markdown Last ned offentlig kontrakt Last ned OpenAPI

Oversikt

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 / gren	Type / påkrevd	Begrensninger
`$`	`object`Påkrevd i forelder	—
`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)$"`
`kind`	`string`Valgfritt / element	`enum: ["video","image","audio","cover","thumbnail","frame","video-source","branding"]`
`customer_ready_only`	`boolean`Valgfritt / element	`default: false`
`limit`	`integer`Valgfritt / element	`minimum: 1` `maximum: 100` `default: 24`
`offset`	`integer`Valgfritt / element	Rader å hoppe over. Opptil 100000 støttes; utover dette returneres 400 OFFSET_TOO_LARGE. `minimum: 0` `maximum: 9007199254740991` `default: 0`

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)$"
    },
    "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"
  ]
}

Svar og fullføring

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

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	—
`assets`	`array`Påkrevd i forelder	—
`assets[]`	`object`Valgfritt / element	—
`assets[].id`	`integer \| string`Påkrevd i forelder	—
`assets[].id`anyOf 1	`integer`Påkrevd i forelder	`minimum: -9007199254740991` `maximum: 9007199254740991`
`assets[].id`anyOf 2	`string`Påkrevd i forelder	—
`assets[].asset_type`	`string`Påkrevd i forelder	`enum: ["text","image","video","audio"]`
`assets[].asset_url`	`string \| null`Påkrevd i forelder	—
`assets[].asset_url`anyOf 1	`string`Påkrevd i forelder	`format: "uri"`
`assets[].asset_url`anyOf 2	`null`Påkrevd i forelder	—
`assets[].preview_url`	`string \| null`Valgfritt / element	Midlertidig lese-URL autorisert for arbeidsområdet. Forny gjennom ressurslesing/-listing etter preview_expires_at; behold asset_url som varig medieidentitet. —
`assets[].preview_url`anyOf 1	`string`Valgfritt / element	`format: "uri"`
`assets[].preview_url`anyOf 2	`null`Valgfritt / element	—
`assets[].preview_expires_at`	`string \| null`Valgfritt / element	—
`assets[].preview_expires_at`anyOf 1	`string`Valgfritt / element	`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`Valgfritt / element	—
`assets[].title`	`string \| null`Påkrevd i forelder	—
`assets[].title`anyOf 1	`string`Påkrevd i forelder	—
`assets[].title`anyOf 2	`null`Påkrevd i forelder	—
`assets[].description`	`string \| null`Påkrevd i forelder	—
`assets[].description`anyOf 1	`string`Påkrevd i forelder	—
`assets[].description`anyOf 2	`null`Påkrevd i forelder	—
`assets[].tags`	`array \| null`Påkrevd i forelder	—
`assets[].tags`anyOf 1	`array`Påkrevd i forelder	—
`assets[].tags[]`anyOf 1	`string`Valgfritt / element	—
`assets[].tags`anyOf 2	`null`Påkrevd i forelder	—
`assets[].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)))$"`
`assets[].readiness`	`object`Påkrevd i forelder	—
`assets[].readiness.status`	`string`Påkrevd i forelder	`enum: ["ready","not_ready"]`
`assets[].readiness.reason_code`	`string`Påkrevd i forelder	`enum: ["ready","unsupported_kind","missing_registered_media","untrusted_workspace_object","media_probe_missing_or_invalid"]`
`assets[].readiness.message`	`string`Påkrevd i forelder	`minLength: 1` `maxLength: 500`
`total`	`integer`Påkrevd i forelder	`minimum: 0` `maximum: 9007199254740991`
`next_offset`	`integer \| null`Påkrevd i forelder	—
`next_offset`anyOf 1	`integer`Påkrevd i forelder	`minimum: 0` `maximum: 9007199254740991`
`next_offset`anyOf 2	`null`Påkrevd i forelder	—

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

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

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

Syntetisk svareksempel

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

MCP: sosoapi_list_assets

Alle API-operasjoner Autentisering og tillatelser