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

MCP tool

Create project export

sosoapi_create_project_export

Start an export of a project (Workspace owner only); poll sosoapi_get_project_export_status for the download URL. idempotency_key required.

Read as Markdown

Profiles and transports

Profiles: 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": false,
  "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
project_idstringRequired in parent
  • format: "uuid"
idempotency_keystringRequired in parent
  • minLength: 8
  • maxLength: 160
Complete JSON Schema
{
  "type": "object",
  "properties": {
    "project_id": {
      "type": "string",
      "format": "uuid"
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 8,
      "maxLength": 160
    }
  },
  "required": [
    "project_id",
    "idempotency_key"
  ],
  "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
contract_versionstringRequired in parent
  • const: "project/v1"
export_idstringRequired in parent
  • format: "uuid"
job_idstringRequired in parent
  • format: "uuid"
statusstringRequired in parent
  • enum: ["queued","processing","completed","failed"]
dedupedbooleanRequired in parent—
Complete JSON Schema
{
  "type": "object",
  "properties": {
    "contract_version": {
      "type": "string",
      "const": "project/v1"
    },
    "export_id": {
      "type": "string",
      "format": "uuid"
    },
    "job_id": {
      "type": "string",
      "format": "uuid"
    },
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "processing",
        "completed",
        "failed"
      ]
    },
    "deduped": {
      "type": "boolean"
    }
  },
  "required": [
    "contract_version",
    "export_id",
    "job_id",
    "status",
    "deduped"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

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_create_project_export",
  "arguments": {
    "project_id": "11111111-1111-4111-8111-111111111111",
    "idempotency_key": "example-intent-0001"
  }
}

structuredContent

{
  "contract_version": "project/v1",
  "export_id": "11111111-1111-4111-8111-111111111111",
  "job_id": "11111111-1111-4111-8111-111111111111",
  "status": "queued",
  "deduped": false
}
Install or connect MCP