Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Extensions

Upload an Extension

Upload an Extension to a Project. The Extension can be provided as a file or via a URL. The method creates a Task to process the creation, and the response includes the task status and progress so you can track completion. This upload always creates a new Extension and doesn't replace any existing ones.

post/v2.0/extensions/upload

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.

Request body

projectIdstring required
urlstring url required

The URL to an Extension. The system will then load the Extension.

namestring

The name of the extension you are trying to upload. This is needed only to fill in the task metadata.

Example request

{
  "url": "https://github.com/Cognigy/Extensions/releases/download/random-cat-image400/random-cat-image.tar.gz"
}

Response

Successfully uploaded the Extension and created a Task to process 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
}