Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Lexicons

Import a Lexicon

Create a task to import a Lexicon from a CSV file.

post/v2.0/lexicons/{lexiconId}/import

Path parameters

lexiconIdstring required

The unique identifier for the Lexicon.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Response

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

_idstring
status'queued' | 'active' | 'done' | 'cancelling' | 'cancelled' | 'error'

The status of the task

typestring
parametersobject
lastChangedAtnumber
lastCreatedAtnumber
currentStepinteger
totalStepinteger

Example response

{
  "status": "queued",
  "type": "trainIntents",
  "lastChangedAt": 1594243850,
  "lastCreatedAt": 1594243850,
  "totalStep": 100
}