WorkItem API Service

A WorkItem API Service publishes a system or custom operator as synchronous HTTP. The caller submits inputs and parameters that follow the operator signature and receives the result in the same request. This fits short, atomic processing; use a workflow for long-running, multi-node work that needs job records.

Current SDK boundary

Neither official SDK currently exposes public methods or types to:

  • inspect WorkItems and their input/output signatures;

  • create, update, enable, or disable an operator API service;

  • retrieve the endpoint and schema of a published service;

  • invoke an arbitrary WorkItem service.

This page therefore does not invent an SDK payload or endpoint. Publish from the operator details in Catalog, or use a Product API explicitly documented by the target MOI instance. Service URLs and fields vary by operator and deployment and must come from the published service’s API Service details.

Publication and invocation checks

Whether publication uses the UI or a supported Product API:

  1. Pin an operator version that has passed sample validation.

  2. Bind a suitable task compute resource for a non-model operator.

  3. Configure authentication, rate, timeout, and concurrency limits.

  4. Validate required fields and types against the generated service schema.

  5. Add a business request ID for deduplication when the operator has write side effects.

  6. Regression-test inputs, outputs, defaults, and errors before upgrading.

Never place API keys or OAuth credentials in workflow definitions, templates, or logs. Public access is appropriate only after data-exposure and abuse risks have been evaluated.

When a future SDK release adds a supported WorkItem Service client, follow its public types. Do not bypass the current boundary through private generic HTTP helpers in RawClient.