Use operators and operator API services

Query available operators, create and maintain custom operators, and publish, enable, disable, or invoke operators as API services. This page does not handle workflow jobs; to run workflows, see Run, resume, and retry workflow jobs.

Prerequisites

Prepare credentials that can access the target workspace. For service endpoints, authentication, and general request formats, see Make your first AI Studio API call.

Before maintaining a custom operator or operator API service, obtain the target ID from the corresponding list or details.

Call sequence

  1. List operators and get details to confirm available operators and their current information.

  2. To create custom processing logic, create a custom operator, query its code and details, then test it after adjustments.

  3. After confirming that a custom operator is usable, publish an operator API service and inspect its configuration.

  4. Enable a service before invoking it. Disable it to stop service temporarily, then enable it again to resume use.

  5. Before deleting a custom operator that is no longer needed, confirm the impact.

API operations

Browse operators

Task

Use it when

Query operators

Find available operators.

Query operator details

You selected an operator and need its information.

Manage custom operators

Task

Use it when

Query custom operators

Find a custom operator or obtain a target ID.

Create a custom operator

Add custom processing logic.

Query custom-operator details

Confirm current information for one custom operator.

Query custom-operator code

View custom-operator code.

Update a custom operator

Adjust an existing custom operator.

Test a custom operator

Validate a custom operator before publishing or use.

Enable a custom operator

Enable a disabled custom operator.

Disable a custom operator

Stop using a custom operator temporarily.

Delete a custom operator

You confirmed that the custom operator is no longer needed.

Publish and invoke API services

Task

Use it when

Publish an operator API service

Provide an operator as an API service.

View operator API service configuration

Confirm service configuration after publishing.

Enable an operator API service

Enable a disabled service.

Disable an operator API service

Stop a service temporarily.

Invoke an operator API service

The service is published and available.

Confirm the result

After creating, updating, enabling, or disabling a custom operator, use Get custom-operator details to confirm current information. After publishing, enabling, or disabling a service, use Get operator API service configuration to confirm service configuration.

Limitations and notes

  • Publishing, enabling, and invoking are separate operations. Confirm service configuration and availability before invocation.

  • Before deleting or disabling a custom operator or disabling an API service, confirm that dependent calls are not affected.

Next steps

Last updated on