Sökningen laddas först när du använder den. Bläddra bland alla kategorier nedan.

MCP-verktyg

Hämta status för mediefilsimport

sosoapi_get_asset_import_status

Läs en import via import_id. För publicering anger du include_asset=true: ett ready-resultat innehåller registrerad mediefils id, kind och stabil asset_url, så att ett separat get_asset inte behövs. Väntande eller saknade mediefiler kan inte schemaläggas. Använd aldrig käll- eller förhandsvisnings-URL som medieidentitet. Om importen har stannat, läs sosoapi_job_status med job_id; starta aldrig en duplicerad import.

Läs som Markdown

Profiler och transporter

Profiler: core, full · Transporter: stdio, http

Välj core eller full för att styra vilka verktyg klienten ser; detta ändrar inte dess behörigheter. Lokal filuppladdning kräver stdio och är inte tillgänglig via HTTP. Ange SOSOAPI_OUTPUT_SCHEMAS=1 för att inkludera utdatascheman vid identifiering. Verktygen returnerar strukturerade resultat med eller utan inställningen.

Behörigheter och sidoeffekter

Annoteringar hjälper klienter att beskriva ett verktyg. Varje anrop kontrollerar fortfarande användarens autentisering, roll, resursåtkomst och tilldelade funktionsbehörigheter.

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false
}

Indatafä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.

Indatafält
Fält / grenTyp / obligatorisktBegränsningar
$objectObligatoriskt i överordnat objekt
  • additionalProperties: false
workspace_idstringObligatoriskt i överordnat objekt
  • format: "uuid"
import_idstringObligatoriskt i överordnat objekt
  • format: "uuid"
include_assetbooleanValfritt / objekt—
Fullständigt JSON Schema
{
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid"
    },
    "import_id": {
      "type": "string",
      "format": "uuid"
    },
    "include_asset": {
      "type": "boolean"
    }
  },
  "required": [
    "workspace_id",
    "import_id"
  ],
  "additionalProperties": false
}

Strukturerat resultat

Detta schema beskriver structuredContent i ett lyckat verktygsresultat. MCP-svaret innehåller även content och kan ange isError när ett anrop misslyckas. För publicering ska du läsa inläggets slutresultat i stället för att tolka en accepterad begäran eller ett textsvar som bekräftelse. Den länkade API-åtgärden förklarar behörigheter och regler för nya försök.

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.

Strukturerat resultat
Fält / grenTyp / obligatorisktBegränsningar
$objectObligatoriskt i överordnat objekt
  • additionalProperties: false
importobjectObligatoriskt i överordnat objekt
  • additionalProperties: false
import.idstringObligatoriskt i överordnat objekt
  • format: "uuid"
import.statusstringObligatoriskt i överordnat objekt
  • enum: ["queued","importing","needs_repair","ready","asset_purged","failed"]
import.job_idstring | nullObligatoriskt i överordnat objekt—
import.job_idanyOf 1stringObligatoriskt i överordnat objekt
  • format: "uuid"
import.job_idanyOf 2nullObligatoriskt i överordnat objekt—
import.asset_idinteger | nullObligatoriskt i överordnat objekt—
import.asset_idanyOf 1integerObligatoriskt i överordnat objekt
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
import.asset_idanyOf 2nullObligatoriskt i överordnat objekt—
import.completed_asset_idinteger | nullObligatoriskt i överordnat objekt—
import.completed_asset_idanyOf 1integerObligatoriskt i överordnat objekt
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
import.completed_asset_idanyOf 2nullObligatoriskt i överordnat objekt—
import.asset_purged_atstring | nullObligatoriskt i överordnat objekt—
import.asset_purged_atanyOf 1stringObligatoriskt i överordnat objekt—
import.asset_purged_atanyOf 2nullObligatoriskt i överordnat objekt—
import.source_urlstringObligatoriskt i överordnat objekt
  • format: "uri"
import.final_urlstring | nullObligatoriskt i överordnat objekt—
import.final_urlanyOf 1stringObligatoriskt i överordnat objekt
  • format: "uri"
import.final_urlanyOf 2nullObligatoriskt i överordnat objekt—
import.object_keystring | nullObligatoriskt i överordnat objekt—
import.object_keyanyOf 1stringObligatoriskt i överordnat objekt
  • minLength: 1
import.object_keyanyOf 2nullObligatoriskt i överordnat objekt—
import.content_typestring | nullObligatoriskt i överordnat objekt—
import.content_typeanyOf 1stringObligatoriskt i överordnat objekt
  • minLength: 1
import.content_typeanyOf 2nullObligatoriskt i överordnat objekt—
import.byte_sizeinteger | nullObligatoriskt i överordnat objekt—
import.byte_sizeanyOf 1integerObligatoriskt i överordnat objekt
  • minimum: 0
  • maximum: 9007199254740991
import.byte_sizeanyOf 2nullObligatoriskt i överordnat objekt—
import.content_sha256string | nullObligatoriskt i överordnat objekt—
import.content_sha256anyOf 1stringObligatoriskt i överordnat objekt
  • pattern: "^[0-9a-f]{64}$"
import.content_sha256anyOf 2nullObligatoriskt i överordnat objekt—
import.media_probereference | nullObligatoriskt i överordnat objekt—
import.media_probeanyOf 1string | number | boolean | null | array | objectObligatoriskt i överordnat objekt—
import.media_probeanyOf 1 / anyOf 1stringObligatoriskt i överordnat objekt—
import.media_probeanyOf 1 / anyOf 2numberObligatoriskt i överordnat objekt—
import.media_probeanyOf 1 / anyOf 3booleanObligatoriskt i överordnat objekt—
import.media_probeanyOf 1 / anyOf 4nullObligatoriskt i överordnat objekt—
import.media_probeanyOf 1 / anyOf 5arrayObligatoriskt i överordnat objekt—
import.media_probe[]anyOf 1 / anyOf 5referenceValfritt / objekt
  • #/definitions/__schema0
import.media_probeanyOf 1 / anyOf 6objectObligatoriskt i överordnat objekt
  • additionalProperties: {"$ref":"#/definitions/__schema0"}
import.media_probe.*anyOf 1 / anyOf 6referenceValfritt / objekt
  • #/definitions/__schema0
import.media_probeanyOf 2nullObligatoriskt i överordnat objekt—
import.error_messagestring | nullObligatoriskt i överordnat objekt—
import.error_messageanyOf 1stringObligatoriskt i överordnat objekt—
import.error_messageanyOf 2nullObligatoriskt i överordnat objekt—
import.created_atstringObligatoriskt i överordnat objekt—
import.completed_atstring | nullObligatoriskt i överordnat objekt—
import.completed_atanyOf 1stringObligatoriskt i överordnat objekt—
import.completed_atanyOf 2nullObligatoriskt i överordnat objekt—
assetobject | nullValfritt / objekt—
assetanyOf 1objectValfritt / objekt
  • additionalProperties: false
asset.idanyOf 1integer | stringObligatoriskt i överordnat objekt—
asset.idanyOf 1 / anyOf 1integerObligatoriskt i överordnat objekt
  • minimum: -9007199254740991
  • maximum: 9007199254740991
asset.idanyOf 1 / anyOf 2stringObligatoriskt i överordnat objekt—
asset.asset_typeanyOf 1stringObligatoriskt i överordnat objekt
  • enum: ["text","image","video","audio"]
asset.asset_urlanyOf 1string | nullObligatoriskt i överordnat objekt—
asset.asset_urlanyOf 1 / anyOf 1stringObligatoriskt i överordnat objekt—
asset.asset_urlanyOf 1 / anyOf 2nullObligatoriskt i överordnat objekt—
assetanyOf 2nullValfritt / objekt—
Fullständigt JSON Schema
{
  "type": "object",
  "properties": {
    "import": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "status": {
          "type": "string",
          "enum": [
            "queued",
            "importing",
            "needs_repair",
            "ready",
            "asset_purged",
            "failed"
          ]
        },
        "job_id": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid"
            },
            {
              "type": "null"
            }
          ]
        },
        "asset_id": {
          "anyOf": [
            {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        },
        "completed_asset_id": {
          "anyOf": [
            {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        },
        "asset_purged_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "source_url": {
          "type": "string",
          "format": "uri"
        },
        "final_url": {
          "anyOf": [
            {
              "type": "string",
              "format": "uri"
            },
            {
              "type": "null"
            }
          ]
        },
        "object_key": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1
            },
            {
              "type": "null"
            }
          ]
        },
        "content_type": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1
            },
            {
              "type": "null"
            }
          ]
        },
        "byte_size": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ]
        },
        "content_sha256": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[0-9a-f]{64}$"
            },
            {
              "type": "null"
            }
          ]
        },
        "media_probe": {
          "anyOf": [
            {
              "$ref": "#/definitions/__schema0"
            },
            {
              "type": "null"
            }
          ]
        },
        "error_message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "created_at": {
          "type": "string"
        },
        "completed_at": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "status",
        "job_id",
        "asset_id",
        "completed_asset_id",
        "asset_purged_at",
        "source_url",
        "final_url",
        "object_key",
        "content_type",
        "byte_size",
        "content_sha256",
        "media_probe",
        "error_message",
        "created_at",
        "completed_at"
      ],
      "additionalProperties": false
    },
    "asset": {
      "anyOf": [
        {
          "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"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "id",
            "asset_type",
            "asset_url"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "import"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "definitions": {
    "__schema0": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/definitions/__schema0"
          }
        },
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "$ref": "#/definitions/__schema0"
          }
        }
      ]
    }
  }
}

Exempel på verktygsanrop

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.

{
  "name": "sosoapi_get_asset_import_status",
  "arguments": {
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "import_id": "11111111-1111-4111-8111-111111111111"
  }
}

structuredContent

{
  "import": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "queued",
    "job_id": null,
    "asset_id": null,
    "completed_asset_id": null,
    "asset_purged_at": null,
    "source_url": "https://example.com/media.png",
    "final_url": null,
    "object_key": null,
    "content_type": null,
    "byte_size": null,
    "content_sha256": null,
    "media_probe": null,
    "error_message": null,
    "created_at": "example",
    "completed_at": null
  }
}
Installera eller anslut MCP