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

MCP tool

List jobs

sosoapi_list_jobs

List the signed-in user's recent background jobs with status and progress.

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": 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
limitintegerOptional / item

Page size, 1 to 100. Sending limit or cursor switches this route to cursor paging and adds next_cursor to the answer.

  • minimum: 1
  • maximum: 100
cursorstringOptional / item

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.

  • minLength: 1
  • maxLength: 512
Complete JSON Schema
{
  "type": "object",
  "properties": {
    "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."
    }
  },
  "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
jobsarrayRequired in parent—
jobs[]objectOptional / item
  • additionalProperties: false
jobs[].idstringRequired in parent
  • format: "uuid"
jobs[].user_idstringRequired in parent
  • format: "uuid"
jobs[].kindstringRequired in parent—
jobs[].statusstringRequired in parent—
jobs[].payloadstring | number | boolean | null | array | objectRequired in parent—
jobs[].payloadanyOf 1stringRequired in parent—
jobs[].payloadanyOf 2numberRequired in parent—
jobs[].payloadanyOf 3booleanRequired in parent—
jobs[].payloadanyOf 4nullRequired in parent—
jobs[].payloadanyOf 5arrayRequired in parent—
jobs[].payload[]anyOf 5referenceOptional / item
  • #/definitions/__schema0
jobs[].payloadanyOf 6objectRequired in parent
  • additionalProperties: {"$ref":"#/definitions/__schema0"}
jobs[].payload.*anyOf 6referenceOptional / item
  • #/definitions/__schema0
jobs[].scheduled_forstring | nullRequired in parent—
jobs[].scheduled_foranyOf 1stringRequired in parent—
jobs[].scheduled_foranyOf 2nullRequired in parent—
jobs[].schedule_timezonestring | nullRequired in parent—
jobs[].schedule_timezoneanyOf 1stringRequired in parent—
jobs[].schedule_timezoneanyOf 2nullRequired in parent—
jobs[].progressinteger | nullRequired in parent—
jobs[].progressanyOf 1integerRequired in parent
  • minimum: 0
  • maximum: 100
jobs[].progressanyOf 2nullRequired in parent—
jobs[].progress_messagestring | nullRequired in parent—
jobs[].progress_messageanyOf 1stringRequired in parent—
jobs[].progress_messageanyOf 2nullRequired in parent—
jobs[].created_atstringRequired in parent—
jobs[].updated_atstringRequired in parent—
next_cursorstring | nullOptional / item

Present only when the request sent limit or cursor. Null on the last page.

—
next_cursoranyOf 1stringOptional / item—
next_cursoranyOf 2nullOptional / item—
Complete JSON Schema
{
  "type": "object",
  "properties": {
    "jobs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "user_id": {
            "type": "string",
            "format": "uuid"
          },
          "kind": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "payload": {
            "$ref": "#/definitions/__schema0"
          },
          "scheduled_for": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "schedule_timezone": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "progress": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0,
                "maximum": 100
              },
              {
                "type": "null"
              }
            ]
          },
          "progress_message": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "user_id",
          "kind",
          "status",
          "payload",
          "scheduled_for",
          "schedule_timezone",
          "progress",
          "progress_message",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false
      }
    },
    "next_cursor": {
      "description": "Present only when the request sent limit or cursor. Null on the last page.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "jobs"
  ],
  "$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_list_jobs",
  "arguments": {}
}

structuredContent

{
  "jobs": []
}
Install or connect MCP