Skip to main content
API Reference
Cards
File Links

File Links let you generate a URL that can be used to download a File.

The File Link object
{
  "created_at": "2020-01-31T23:59:59Z",
  "expires_at": "2020-01-31T23:59:59Z",
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "file_link_roapsuicj7kp1lzyus04",
  "idempotency_key": null,
  "type": "file_link",
  "unauthenticated_url": "https://example.com/file.pdf"
}
Attributes

The ISO 8601 time at which the File Link was created.

The ISO 8601 time at which the File Link will expire.

The identifier of the File the File Link points to.

More about Files.

The File Link identifier.

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

A constant representing the object’s type. For this resource it will always be file_link.

A URL where the File can be downloaded. The URL will expire after the expires_at time. This URL is unauthenticated and can be used to download the File without an Increase API key.

Create a File Link
curl -X "POST" \
  --url "${INCREASE_URL}/file_links" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "file_id": "file_makxrc67oh9l6sg7w9yc"
  }'
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const fileLink = await client.fileLinks.create({ file_id: 'file_makxrc67oh9l6sg7w9yc' });

console.log(fileLink.id);
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
file_link = client.file_links.create(
    file_id="file_makxrc67oh9l6sg7w9yc",
)
print(file_link.id)
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

file_link = increase.file_links.create(file_id: "file_makxrc67oh9l6sg7w9yc")

puts(file_link)
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	fileLink, err := client.FileLinks.New(context.TODO(), increase.FileLinkNewParams{
		FileID: increase.F("file_makxrc67oh9l6sg7w9yc"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", fileLink.ID)
}
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.filelinks.FileLink;
import com.increase.api.models.filelinks.FileLinkCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        FileLinkCreateParams params = FileLinkCreateParams.builder()
            .fileId("file_makxrc67oh9l6sg7w9yc")
            .build();
        FileLink fileLink = client.fileLinks().create(params);
    }
}
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.filelinks.FileLink
import com.increase.api.models.filelinks.FileLinkCreateParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val params: FileLinkCreateParams = FileLinkCreateParams.builder()
        .fileId("file_makxrc67oh9l6sg7w9yc")
        .build()
    val fileLink: FileLink = client.fileLinks().create(params)
}
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $fileLink = $client->fileLinks->create(
    fileID: 'file_makxrc67oh9l6sg7w9yc',
    expiresAt: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
  );

  var_dump($fileLink);
} catch (APIException $e) {
  echo $e->getMessage();
}
using System;
using Increase.Api;
using Increase.Api.Models.FileLinks;

IncreaseClient client = new();

FileLinkCreateParams parameters = new()
{
    FileID = "file_makxrc67oh9l6sg7w9yc"
};

var fileLink = await client.FileLinks.Create(parameters);

Console.WriteLine(fileLink);
Parameters
expires_at
string

The time at which the File Link will expire. The default is 1 hour from the time of the request. The maximum is 1 day from the time of the request.

file_id
string
Required

The File to create a File Link for.

More about Files.