## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.cognigy.com/llms.txt)

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

POST

/v2.0/packages/{packageId}/downloadlink

### Try it

#### Create a Download Link

**cURL**

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

**Python**

```python
import requests

url = "https://api-trial.cognigy.ai/new/v2.0/packages/{packageId}/downloadlink"

headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)
```

**JavaScript (Fetch)**

```javascript
const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-trial.cognigy.ai/new/v2.0/packages/{packageId}/downloadlink', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

**PHP**

```php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/packages/{packageId}/downloadlink",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

**Go**

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

url := "https://api-trial.cognigy.ai/new/v2.0/packages/{packageId}/downloadlink"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}
```

**Java (Unirest)**

```java
HttpResponse<String> response = Unirest.post("https://api-trial.cognigy.ai/new/v2.0/packages/{packageId}/downloadlink")
  .header("X-API-Key", "<api-key>")
  .asString();
```

**Ruby**

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/packages/{packageId}/downloadlink")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
```

### Response

**Possible Status Codes:**

- **200**: Package download link retrieved.
- **400**: Bad Request.
- **401**: Unauthorized.
- **402**: Payment Required.
- **403**: Forbidden.
- **404**: Not Found.
- **405**: Method Not Allowed.
- **409**: Conflict.
- **413**: Payload Too Large.
- **500**: Internal Server Error.
- **501**: Not Implemented.
- **502**: Bad Gateway.
- **503**: Service Unavailable.
- **504**: Gateway Timeout.

**Response Example for Success:**

```json
{
  "downloadLink": "<string>"
}
```

**Error Response Example:**

```json
{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}
```

### Authorizations

| Name             | Type   | In     | Required | Description                                    |
|------------------|--------|--------|----------|------------------------------------------------|
| X-API-Key        | string | header | Yes      | Supply the API Key in the HTTP-Header         |

### Headers

| Name   | Type       | Description                                                                                  |
|--------|------------|----------------------------------------------------------------------------------------------|
| Accept | enum<string>| 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`. |

### Path Parameters

| Name       | Type   | Required | Description                           |
|------------|--------|----------|---------------------------------------|
| packageId  | string | Yes      | The unique identifier for the Package. Required string length: `24`. Pattern: `^[a-z0-9]{24}$`. |

### Response Structure

- **200:**
  - application/json: Package download link retrieved.