Import a Lexicon - Cognigy Documentation

curl --request POST \ --url https://api-trial.cognigy.ai/new/v2.0/lexicons/{lexiconId}/import \ --header 'Content-Type: multipart/form-data' \ --header 'X-API-Key: <api-key>' \ --form mode=skip \ --form file='@example-file'

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Headers

enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

lexiconId

string

required

The unique identifier for the Lexicon.

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Body

multipart/form-data

mode

enum<string>

Available options:

skip,

overwrite,

merge

Example:

"skip"

file

Response

Successfully uploaded your Lexicon data and created a Task for importing it.

_id

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

status

enum<string>

The status of the task

Available options:

queued,

active,

done,

cancelling,

cancelled,

error

Example:

"queued"

type

string

Example:

"trainIntents"

parameters

object

lastChangedAt

number

Example:

1594243850

lastCreatedAt

number

Example:

1594243850

currentStep

integer

Example:

0

totalStep

integer

Example:

100