Building skills by importing OpenAPI files

A great value that you get from watsonx Orchestrate is the ability to build skills that anyone can use. You can build your custom skill by importing an OpenAPI file into watsonx Orchestrate.

Before you begin

Before you import your OpenAPI file into watsonx Orchestrate to build the skills, check if your OpenAPI has the following prerequisites:

  • The version used by the OpenAPI must be from 3.0.0 to 3.0.3.
  • The characters tab, new line, or carriage return must not be used in the description property.
  • The summary must be defined in each /path method on the OAS.
  • The OpenAPI must contain only skills based on the GET, PATCH, PUT, POST, and DELETE.
  • The server URL must be one HTTPS server.
  • The OpenAPI must contain only one API authentication method.
  • The request and response type for the skills input and output must be application/json.

Importing the OpenAPI file

Follow the procedure to build skills from files:

  1. From the menu menu, select Skill studio.
  2. Click Create and choose the Import API option.
  3. Choose From a file to import an OpenAPI file.
  4. Drag files or click to upload your OpenAPI file.
    • If an error appears, click View details to get more information.
  5. Click Next.
  6. All the skills in your OpenAPI are listed. You can add the listed skill only when it shows a Ready to add status.
    • If the status Not ready to add appears, expand the skill and analyze the error information provided in Issue List.
  7. Click the checkbox next to the selected skills to add the skills from the OpenAPI file.
  8. Click Add. You see a notification when the skill is successfully imported.

You can now see your newly built skill on the Skills and apps page. However, the skill is not yet published; it needs to be enhanced and then published.