Projekt och innehåll

Lista projekt

Lista en arbetsytas projekt (ett valfritt lager för ursprung och kontostandarder) och vilket som är aktivt.

POST /studio-api/projects/list

Kontrakt granskat: 2026-10-21 · sha256:563d2d581da0ad29

Läs som Markdown Ladda ned offentligt kontrakt Ladda ned OpenAPI

Översikt

Lista en arbetsytas projekt (ett valfritt lager för ursprung och kontostandarder) och vilket som är aktivt.

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: viewer
Åtkomstomfång: Resurser som denna användare har behörighet att komma åt
Samtycke för alla arbetsytor krävs: Nej
Ändrar tillstånd: Nej
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.

Anropsfält
Fält / gren	Typ / obligatoriskt	Begränsningar
`$`	`object`Obligatoriskt i överordnat objekt	`additionalProperties: false`
`workspace_id`	`string`Obligatoriskt i överordnat objekt	`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)$"`
`limit`	`integer`Valfritt / objekt	Sidstorlek, 1 till 100. Att skicka limit eller cursor växlar rutten till markörbaserad sidindelning och lägger till next_cursor i svaret. `minimum: 1` `maximum: 100`
`cursor`	`string`Valfritt / objekt	Ogenomskinlig markör: föregående sidas next_cursor, oförändrad. Utelämna den på första sidan. Samma filter måste skickas med varje sida. `minLength: 1` `maxLength: 512`
`include_version`	`boolean`Valfritt / objekt	Valfritt. true lägger till resursversionen i svaret. —

Fullständigt 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)$"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "description": "Page size, 1 to 100. Sending limit or cursor switches this route to cursor paging and adds next_cursor to the answer."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "description": "Opaque cursor: the next_cursor of the previous page, unchanged. Omit it for the first page. The same filters must be sent with every page."
    },
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

Svar och slutförande

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

Svar och slutförande
Fält / gren	Typ / obligatoriskt	Begränsningar
`$`	`object`Obligatoriskt i överordnat objekt	—
`projects`	`array`Obligatoriskt i överordnat objekt	—
`projects[]`	`object`Valfritt / objekt	—
`projects[].id`	`string`Obligatoriskt i överordnat objekt	`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)$"`
`projects[].workspace_id`	`string`Obligatoriskt i överordnat objekt	`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)$"`
`projects[].name`	`string`Obligatoriskt i överordnat objekt	`minLength: 1` `maxLength: 200`
`projects[].operational_state`	`string`Obligatoriskt i överordnat objekt	`enum: ["active","archived"]`
`projects[].lifecycle_version`	`integer`Obligatoriskt i överordnat objekt	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`projects[].defaults_version`	`integer`Obligatoriskt i överordnat objekt	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`projects[].archived_at`	`string \| null`Obligatoriskt i överordnat objekt	—
`projects[].archived_at`anyOf 1	`string`Obligatoriskt i överordnat objekt	—
`projects[].archived_at`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`projects[].archived_by`	`string \| null`Obligatoriskt i överordnat objekt	—
`projects[].archived_by`anyOf 1	`string`Obligatoriskt i överordnat objekt	`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)$"`
`projects[].archived_by`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`projects[].archived_by_api_key_id`	`string \| null`Obligatoriskt i överordnat objekt	—
`projects[].archived_by_api_key_id`anyOf 1	`string`Obligatoriskt i överordnat objekt	`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)$"`
`projects[].archived_by_api_key_id`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`projects[].created_at`	`string`Obligatoriskt i överordnat objekt	—
`projects[].updated_at`	`string`Obligatoriskt i överordnat objekt	—
`projects[].version`	`integer`Valfritt / objekt	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`active_project_id`	`string \| null`Obligatoriskt i överordnat objekt	—
`active_project_id`anyOf 1	`string`Obligatoriskt i överordnat objekt	`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)$"`
`active_project_id`anyOf 2	`null`Obligatoriskt i överordnat objekt	—
`next_cursor`	`string \| null`Valfritt / objekt	Finns endast när begäran skickade limit eller cursor. Null på sista sidan. —
`next_cursor`anyOf 1	`string`Valfritt / objekt	—
`next_cursor`anyOf 2	`null`Valfritt / objekt	—

Fullständigt JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "projects": {
      "type": "array",
      "items": {
        "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)$"
          },
          "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)$"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "operational_state": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ]
          },
          "lifecycle_version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "defaults_version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "archived_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "archived_by": {
            "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"
              }
            ]
          },
          "archived_by_api_key_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"
              }
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "id",
          "workspace_id",
          "name",
          "operational_state",
          "lifecycle_version",
          "defaults_version",
          "archived_at",
          "archived_by",
          "archived_by_api_key_id",
          "created_at",
          "updated_at"
        ]
      }
    },
    "active_project_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"
        }
      ]
    },
    "next_cursor": {
      "description": "Present only when the request sent limit or cursor. Null on the last page.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "projects",
    "active_project_id"
  ]
}

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.

Felsökningsguide

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

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/projects/list" \
  -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/studio-api/projects/list", {
  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 /studio-api/projects/list < request.json

Syntetiskt svarsexempel

{
  "projects": [],
  "active_project_id": null
}

MCP: sosoapi_list_projects

Alla API-åtgärder Autentisering och behörigheter