Skip to main content
DELETE
/
v2.0
/
snapshots
/
{snapshotId}
Create a Task to delete a Snapshot
curl --request DELETE \
  --url 'https://api-trial.cognigy.ai/new/v2.0/snapshots/{snapshotId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "_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

​
api_key
string
query
required

Supply the API Key in the Url-Query

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
snapshotId
string
required

The Id of the Snapshot

Required string length: 24

Response

Successfully created Task to delete 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