Médias et ressources

Lister les ressources

Lister les ressources d’un espace de travail filtrées par kind (video, image, audio, cover, thumbnail, frame, video-source, branding) ou customer_ready_only, avec pagination next_offset. workspace_id est requis.

POST /assets-api/list-workspace

Contrat vérifié : 2026-10-21 · sha256:563d2d581da0ad29

Lire en Markdown Télécharger le contrat public Télécharger OpenAPI

Présentation

Une réponse HTTP réussie peut signifier qu’une requête est acceptée plutôt que terminée. Pour le travail en arrière-plan, conservez l’identifiant renvoyé et suivez la même opération jusqu’à sa fin. Une publication programmée ou acceptée n’est publiée que lorsque la plateforme le confirme ; une expiration côté client ne détermine pas le résultat.

Authentification et autorisations

Types d’identifiants acceptés: user_session, delegated_oauth, personal_access_token
Capacité déléguée: agent:operate
Rôle minimal dans l’espace de travail: viewer
Périmètre d’accès: Ressources auxquelles cet utilisateur est autorisé à accéder
Consentement pour tous les espaces requis: Non
Modifie l’état: Non
Lorsque l’opération est terminée: synchronous_http_response

Un jeton ne peut utiliser que les droits de son propriétaire. Chaque requête vérifie l’appartenance à l’espace, la propriété des ressources, les espaces sélectionnés et les capacités accordées. Les profils core et full modifient les outils affichés ; ils n’accordent aucun accès.

Champs de requête

Requis signifie requis dans l’objet parent et la branche sélectionnée. Un enfant requis ne rend pas obligatoire un parent facultatif. Les règles et noms de champs ci-dessous proviennent du contrat.

Champs de requête
Champ / branche	Type / requis	Contraintes
`$`	`object`Requis dans le parent	—
`workspace_id`	`string`Requis dans le parent	`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`Facultatif / élément	`enum: ["video","image","audio","cover","thumbnail","frame","video-source","branding"]`
`customer_ready_only`	`boolean`Facultatif / élément	`default: false`
`limit`	`integer`Facultatif / élément	`minimum: 1` `maximum: 100` `default: 24`
`offset`	`integer`Facultatif / élément	Lignes à ignorer. Pris en charge jusqu’à 100000 ; au-delà, 400 OFFSET_TOO_LARGE. `minimum: 0` `maximum: 9007199254740991` `default: 0`

JSON Schema complet

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

Réponse et achèvement

Statuts HTTP de réussite : 200. Lorsque l’opération est terminée : synchronous_http_response.

Réponse et achèvement
Champ / branche	Type / requis	Contraintes
`$`	`object`Requis dans le parent	—
`assets`	`array`Requis dans le parent	—
`assets[]`	`object`Facultatif / élément	—
`assets[].id`	`integer \| string`Requis dans le parent	—
`assets[].id`anyOf 1	`integer`Requis dans le parent	`minimum: -9007199254740991` `maximum: 9007199254740991`
`assets[].id`anyOf 2	`string`Requis dans le parent	—
`assets[].asset_type`	`string`Requis dans le parent	`enum: ["text","image","video","audio"]`
`assets[].asset_url`	`string \| null`Requis dans le parent	—
`assets[].asset_url`anyOf 1	`string`Requis dans le parent	`format: "uri"`
`assets[].asset_url`anyOf 2	`null`Requis dans le parent	—
`assets[].preview_url`	`string \| null`Facultatif / élément	URL temporaire de lecture autorisée pour l’espace de travail. Actualisez-la via la lecture/liste des ressources après preview_expires_at ; conservez asset_url comme identité persistante du média. —
`assets[].preview_url`anyOf 1	`string`Facultatif / élément	`format: "uri"`
`assets[].preview_url`anyOf 2	`null`Facultatif / élément	—
`assets[].preview_expires_at`	`string \| null`Facultatif / élément	—
`assets[].preview_expires_at`anyOf 1	`string`Facultatif / élément	`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`Facultatif / élément	—
`assets[].title`	`string \| null`Requis dans le parent	—
`assets[].title`anyOf 1	`string`Requis dans le parent	—
`assets[].title`anyOf 2	`null`Requis dans le parent	—
`assets[].description`	`string \| null`Requis dans le parent	—
`assets[].description`anyOf 1	`string`Requis dans le parent	—
`assets[].description`anyOf 2	`null`Requis dans le parent	—
`assets[].tags`	`array \| null`Requis dans le parent	—
`assets[].tags`anyOf 1	`array`Requis dans le parent	—
`assets[].tags[]`anyOf 1	`string`Facultatif / élément	—
`assets[].tags`anyOf 2	`null`Requis dans le parent	—
`assets[].created_at`	`string`Requis dans le parent	`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`Requis dans le parent	—
`assets[].readiness.status`	`string`Requis dans le parent	`enum: ["ready","not_ready"]`
`assets[].readiness.reason_code`	`string`Requis dans le parent	`enum: ["ready","unsupported_kind","missing_registered_media","untrusted_workspace_object","media_probe_missing_or_invalid"]`
`assets[].readiness.message`	`string`Requis dans le parent	`minLength: 1` `maxLength: 500`
`total`	`integer`Requis dans le parent	`minimum: 0` `maximum: 9007199254740991`
`next_offset`	`integer \| null`Requis dans le parent	—
`next_offset`anyOf 1	`integer`Requis dans le parent	`minimum: 0` `maximum: 9007199254740991`
`next_offset`anyOf 2	`null`Requis dans le parent	—

JSON Schema complet

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

Erreurs et nouvelles tentatives sûres

Vérifiez le statut HTTP et le corps de réponse. Une erreur de validation 400 peut contenir un ZodError ; les erreurs des gestionnaires utilisent les champs error, message et code. Conservez request_id ou x-request-id pour le diagnostic, sans identifiants secrets. Corrigez les erreurs d’accès 401/403 avant de réessayer et respectez Retry-After pour 429. Si une écriture est incertaine ou renvoie 5xx, lisez d’abord le résultat existant. Réutilisez une clé d’idempotence uniquement lorsque c’est pris en charge ; le comportement des nouvelles tentatives varie selon l’opération et ne garantit pas une diffusion exactement une fois.

Guide de dépannage

Exemples

Ces exemples utilisent des valeurs fictives vérifiées contre les schémas. Remplacez les identifiants par ceux que vous êtes autorisé à utiliser, les médias par des ressources prêtes et les dates par l’heure confirmée. Vérifiez l’éligibilité du compte avant toute écriture. Cette page n’envoie aucune requête API.

Définissez SOSOAPI_ACCESS_TOKEN sur votre serveur avec un identifiant accepté par cette opération et gardez-le hors du code navigateur. Pour un agent, utilisez sosoapi auth login pour vous connecter dans le navigateur et laissez la CLI actualiser ses identifiants.

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

Exemple de réponse fictive

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

MCP : sosoapi_list_assets

Toutes les opérations API Authentification et autorisations