Search loads only when you use it. Browse all categories below.

MCP tool

Get asset import status

sosoapi_get_asset_import_status

Read an import by import_id. For posting pass include_asset=true: a ready result includes the registered asset id, kind and stable asset_url, avoiding a separate get_asset. Pending or missing assets cannot be scheduled. Never use the source or preview URL as media identity. If stalled, read sosoapi_job_status with job_id; never start a duplicate import.

Read as Markdown

Profiles and transports

Profiles: core, full · Transports: stdio, http

Choose core or full to control which tools your client sees; this does not change its permissions. Local file upload requires stdio and is unavailable over HTTP. Set SOSOAPI_OUTPUT_SCHEMAS=1 to include output schemas in discovery. Tools return structured results with or without that setting.

Permissions and side effects

Annotations help clients describe a tool. Each call still checks the user’s authentication, role, resource access and capability grants.

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

Input fields

Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.

Input fields
Field / branchType / requiredConstraints
$objectRequired in parent
  • additionalProperties: false
workspace_idstringRequired in parent
  • format: "uuid"
import_idstringRequired in parent
  • format: "uuid"
include_assetbooleanOptional / item—
Complete 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
}

Structured output

This schema describes structuredContent in a successful tool result. The MCP response also includes content and may set isError when a call fails. For publishing, read the post’s final result rather than treating an accepted request or text response as confirmation. The linked API operation explains permissions and retry rules.

Required means required inside its parent object and selected branch. A required child does not make an optional parent required. Rules and field names below are copied from the contract.

Structured output
Field / branchType / requiredConstraints
$objectRequired in parent
  • additionalProperties: false
importobjectRequired in parent
  • additionalProperties: false
import.idstringRequired in parent
  • format: "uuid"
import.statusstringRequired in parent
  • enum: ["queued","importing","needs_repair","ready","asset_purged","failed"]
import.job_idstring | nullRequired in parent—
import.job_idanyOf 1stringRequired in parent
  • format: "uuid"
import.job_idanyOf 2nullRequired in parent—
import.asset_idinteger | nullRequired in parent—
import.asset_idanyOf 1integerRequired in parent
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
import.asset_idanyOf 2nullRequired in parent—
import.completed_asset_idinteger | nullRequired in parent—
import.completed_asset_idanyOf 1integerRequired in parent
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
import.completed_asset_idanyOf 2nullRequired in parent—
import.asset_purged_atstring | nullRequired in parent—
import.asset_purged_atanyOf 1stringRequired in parent—
import.asset_purged_atanyOf 2nullRequired in parent—
import.source_urlstringRequired in parent
  • format: "uri"
import.final_urlstring | nullRequired in parent—
import.final_urlanyOf 1stringRequired in parent
  • format: "uri"
import.final_urlanyOf 2nullRequired in parent—
import.object_keystring | nullRequired in parent—
import.object_keyanyOf 1stringRequired in parent
  • minLength: 1
import.object_keyanyOf 2nullRequired in parent—
import.content_typestring | nullRequired in parent—
import.content_typeanyOf 1stringRequired in parent
  • minLength: 1
import.content_typeanyOf 2nullRequired in parent—
import.byte_sizeinteger | nullRequired in parent—
import.byte_sizeanyOf 1integerRequired in parent
  • minimum: 0
  • maximum: 9007199254740991
import.byte_sizeanyOf 2nullRequired in parent—
import.content_sha256string | nullRequired in parent—
import.content_sha256anyOf 1stringRequired in parent
  • pattern: "^[0-9a-f]{64}$"
import.content_sha256anyOf 2nullRequired in parent—
import.media_probereference | nullRequired in parent—
import.media_probeanyOf 1string | number | boolean | null | array | objectRequired in parent—
import.media_probeanyOf 1 / anyOf 1stringRequired in parent—
import.media_probeanyOf 1 / anyOf 2numberRequired in parent—
import.media_probeanyOf 1 / anyOf 3booleanRequired in parent—
import.media_probeanyOf 1 / anyOf 4nullRequired in parent—
import.media_probeanyOf 1 / anyOf 5arrayRequired in parent—
import.media_probe[]anyOf 1 / anyOf 5referenceOptional / item
  • #/definitions/__schema0
import.media_probeanyOf 1 / anyOf 6objectRequired in parent
  • additionalProperties: {"$ref":"#/definitions/__schema0"}
import.media_probe.*anyOf 1 / anyOf 6referenceOptional / item
  • #/definitions/__schema0
import.media_probeanyOf 2nullRequired in parent—
import.error_messagestring | nullRequired in parent—
import.error_messageanyOf 1stringRequired in parent—
import.error_messageanyOf 2nullRequired in parent—
import.created_atstringRequired in parent—
import.completed_atstring | nullRequired in parent—
import.completed_atanyOf 1stringRequired in parent—
import.completed_atanyOf 2nullRequired in parent—
assetobject | nullOptional / item—
assetanyOf 1objectOptional / item
  • additionalProperties: false
asset.idanyOf 1integer | stringRequired in parent—
asset.idanyOf 1 / anyOf 1integerRequired in parent
  • minimum: -9007199254740991
  • maximum: 9007199254740991
asset.idanyOf 1 / anyOf 2stringRequired in parent—
asset.asset_typeanyOf 1stringRequired in parent
  • enum: ["text","image","video","audio"]
asset.asset_urlanyOf 1string | nullRequired in parent—
asset.asset_urlanyOf 1 / anyOf 1stringRequired in parent—
asset.asset_urlanyOf 1 / anyOf 2nullRequired in parent—
assetanyOf 2nullOptional / item—
Complete 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"
          }
        }
      ]
    }
  }
}

Example tool call

These examples use fictional values checked against the schemas. Replace the IDs with ones you are authorized to use, the media with ready assets and the dates with your confirmed publishing time. Check the account’s eligibility before submitting a write. This page sends no API requests.

{
  "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
  }
}
Install or connect MCP