Get a SlotFiller - Cognigy Documentation

GET

v2.0

flows

{flowId}

slotfillers

{slotFillerId}

Get a SlotFiller

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/slotfillers/{slotFillerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "<string>",
  "type": "age",
  "usePositiveOnly": true,
  "removeNegated": true,
  "storeResultInContext": true,
  "contextKey": "<string>",
  "storeInContactProfile": true,
  "profileKey": "<string>",
  "storeDetailedResults": true,
  "skipIfResultInContext": true,
  "additionalValidation": "<string>",
  "resultLocation": "<string>",
  "regex": "<string>",
  "slot": "<string>",
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key

string

query

required

Supply the API Key in the Url-Query

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

flowId

string

required

The Id of the Flow

Required string length: 24

slotFillerId

string

required

The Id of the SlotFiller

Required string length: 24

Response

Returns SlotFiller Object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

name

string

type

enum<string>

Available options:

age,

date,

duration,

email,

intent,

slot,

money,

number,

percentage,

regex,

temperature

Example:

"age"

usePositiveOnly

boolean

removeNegated

boolean

storeResultInContext

boolean

contextKey

string

storeInContactProfile

boolean

profileKey

string

storeDetailedResults

boolean

skipIfResultInContext

boolean

additionalValidation

string

resultLocation

string

regex

string

slot

string

referenceId

string<uuid>

_id

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

lastChangedBy

string

Required string length: 24

Delete a SlotFillerDelete a [SlotFiller](doc:slotfiller).

⌘I

Get a SlotFiller

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/slotfillers/{slotFillerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "<string>",
  "type": "age",
  "usePositiveOnly": true,
  "removeNegated": true,
  "storeResultInContext": true,
  "contextKey": "<string>",
  "storeInContactProfile": true,
  "profileKey": "<string>",
  "storeDetailedResults": true,
  "skipIfResultInContext": true,
  "additionalValidation": "<string>",
  "resultLocation": "<string>",
  "regex": "<string>",
  "slot": "<string>",
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}