Skip to main content
POST
/
v2.0
/
snapshots
Create a Task to create a new Snapshot
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/snapshots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "New Snapshot",
  "description": "Version 1",
  "projectId": "<string>"
}'
{
  "_id": "<string>",
  "status": "queued",
  "type": "trainIntents",
  "parameters": {},
  "lastChangedAt": 1594243850,
  "lastCreatedAt": 1594243850,
  "currentStep": 0,
  "totalStep": 100
}

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

Body

application/json
​
name
string

The name of the Snapshot

Example:

"New Snapshot"

​
description
string

The description of the Snapshot

Example:

"Version 1"

​
projectId
string
Required string length: 24

Response

Created a Task to create the Snapshot.

​
_id
string
Required string length: 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

⌘I