• Public
  • Public/Protected
  • All

Interface WebApiSkill

Package version

A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.


  • WebApiSkill



Optional batchSize

batchSize: undefined | number

The desired batch size which indicates number of documents.

Optional context

context: undefined | string

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

Optional degreeOfParallelism

degreeOfParallelism: undefined | number

If set, the number of parallel calls that can be made to the Web API.

Optional description

description: undefined | string

The description of the skill which describes the inputs, outputs, and usage of the skill.

Optional httpHeaders

httpHeaders: undefined | {}

The headers required to make the http request.

Optional httpMethod

httpMethod: undefined | string

The method for the http request.


Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

Optional name

name: undefined | string

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.


odatatype: "#Microsoft.Skills.Custom.WebApiSkill"

Polymorphic Discriminator


The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

Optional timeout

timeout: undefined | string

The desired timeout for the request. Default is 30 seconds.


uri: string

The url for the Web API.

Generated using TypeDoc