Skip to main content
POST
/
v2.0
/
snapshots
Create a Snapshot
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/snapshots \
  --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
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

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

The unique identifier for the Project.

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

Response

Created a Task to create the Snapshot.

ā€‹
_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