Get a Package - Cognigy Documentation

GET

v2.0

packages

{packageId}

Get a Package

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/packages/{packageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "New Package",
  "description": "Version 1",
  "_id": "<string>",
  "hash": "Version 1",
  "createdBy": "<string>",
  "createdAt": 1694518620
}

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

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

packageId

string

required

The Id of the Package

Required string length: 24

Response

Returns Package Object

name

string

The name of the Package

Example:

"New Package"

description

string

The description of the Package

Example:

"Version 1"

_id

string

Required string length: 24

hash

string

The hash identifying the contents of the Package

Example:

"Version 1"

createdBy

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

Create a Task to delete a PackageCreate a Task to delete a [Package](doc:package).

⌘I

Get a Package

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/packages/{packageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "New Package",
  "description": "Version 1",
  "_id": "<string>",
  "hash": "Version 1",
  "createdBy": "<string>",
  "createdAt": 1694518620
}