Signera en mediefilsuppladdning

Översikt

Hämta en signerad uppladdnings-URL för ett medieobjekt i din arbetsyta. Ladda upp filens byte till URL:en och anropa sedan upload/complete för att registrera mediefilen. Denna slutpunkt läser ingen lokal fil åt dig.

Ett lyckat HTTP-svar kan betyda att en begäran accepterats snarare än slutförts. Spara returnerat ID för bakgrundsarbete och kontrollera samma åtgärd tills den är klar. Ett schemalagt eller accepterat inlägg är publicerat först när plattformen bekräftar det; en klienttimeout fastställer inte resultatet.

Autentisering och behörigheter

Godtagna typer av autentiseringsuppgifter

user_session, delegated_oauth, personal_access_token

Delegerad funktion

agent:operate

Lägsta arbetsyteroll

editor

Åtkomstomfång

Resurser som denna användare har behörighet att komma åt

Samtycke för alla arbetsytor krävs

Nej

Ändrar tillstånd

Ja

När åtgärden är klar

synchronous_http_response

En token får endast använda ägarens rättigheter. Varje anrop kontrollerar arbetsytemedlemskap, resursägarskap, valda arbetsytor och beviljade funktioner. Profilerna core och full ändrar vilka verktyg som visas; de ger ingen åtkomst.

Anropsfält

Obligatoriskt betyder obligatoriskt inom sitt överordnade objekt och vald gren. Ett obligatoriskt underfält gör inte ett valfritt överordnat objekt obligatoriskt. Regler och fältnamn nedan kopieras från kontraktet.

{
  "$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)$"
    },
    "asset_type": {
      "type": "string",
      "enum": [
        "image",
        "video"
      ]
    },
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "content_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "byte_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 524288000,
      "description": "Exact length in bytes of the body you will PUT (max 500 MiB). It is signed into the upload URL as Content-Length, counted against the workspace storage limit, and checked again when you complete the upload: an object longer than declared is rejected and removed."
    },
    "content_sha256": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    },
    "title": {
      "type": "string",
      "maxLength": 200
    }
  },
  "required": [
    "workspace_id",
    "asset_type",
    "filename",
    "content_type",
    "byte_size",
    "content_sha256"
  ],
  "additionalProperties": false
}

Svar och slutförande

HTTP-status vid framgång: 200. När åtgärden är klar: synchronous_http_response.

Ett lyckat HTTP-svar kan betyda att en begäran accepterats snarare än slutförts. Spara returnerat ID för bakgrundsarbete och kontrollera samma åtgärd tills den är klar. Ett schemalagt eller accepterat inlägg är publicerat först när plattformen bekräftar det; en klienttimeout fastställer inte resultatet.

Obligatoriskt betyder obligatoriskt inom sitt överordnade objekt och vald gren. Ett obligatoriskt underfält gör inte ett valfritt överordnat objekt obligatoriskt. Regler och fältnamn nedan kopieras från kontraktet.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "object_key": {
      "type": "string",
      "minLength": 1
    },
    "public_url": {
      "type": "string",
      "format": "uri"
    },
    "signed_url": {
      "type": "string",
      "format": "uri"
    },
    "upload_headers": {
      "type": "object",
      "properties": {
        "Content-Type": {
          "type": "string",
          "minLength": 1
        },
        "x-amz-checksum-sha256": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "Content-Type",
        "x-amz-checksum-sha256"
      ]
    },
    "expires_seconds": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "object_key",
    "public_url",
    "signed_url",
    "upload_headers",
    "expires_seconds"
  ]
}

Fel och säkra nya försök

Kontrollera HTTP-status och svarskropp. Ett valideringsfel med 400 kan innehålla ZodError; hanterarfel använder fälten error, message och code. Spara request_id eller x-request-id för felsökning, utan inloggningsuppgifter. Åtgärda åtkomstfel med 401/403 innan du försöker igen och följ Retry-After vid 429. Om en skrivning är osäker eller returnerar 5xx, läs först det befintliga resultatet. Återanvänd en idempotensnyckel endast där det stöds; försöksbeteendet varierar mellan åtgärder och garanterar inte leverans exakt en gång.

Exempel

Exemplen använder fiktiva värden som kontrollerats mot schemana. Ersätt ID:n med sådana du får använda, medier med färdiga mediefiler och datum med din bekräftade publiceringstid. Kontrollera kontots behörighet före en skrivning. Denna sida skickar inga API-anrop.

Sätt SOSOAPI_ACCESS_TOKEN på servern till en autentiseringsuppgift som åtgärden godtar och håll den borta från webbläsarkod. För en agent använder du sosoapi auth login för att logga in via webbläsaren och låter CLI förnya sina uppgifter.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "asset_type": "image",
  "filename": "example.png",
  "content_type": "image/png",
  "byte_size": 1,
  "content_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/upload/sign" \
  -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/upload/sign", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "asset_type": "image",
  "filename": "example.png",
  "content_type": "image/png",
  "byte_size": 1,
  "content_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /assets-api/upload/sign < request.json

Syntetiskt svarsexempel

{
  "object_key": "example",
  "public_url": "https://example.com/media.png",
  "signed_url": "https://example.com/media.png",
  "upload_headers": {
    "Content-Type": "example",
    "x-amz-checksum-sha256": "example"
  },
  "expires_seconds": 1
}

Relaterade verktyg och guider

MCP: sosoapi_upload_asset