cURL

curl --request POST \
  --url https://api.dock.us/{version}/assets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "pdf",
  "name": "Sales deck",
  "fileId": "f9Ghw2n0Ju3D",
  "description": "<string>",
  "tagIds": [
    "RiHO4e0Ju3DS"
  ],
  "isInternal": false,
  "url": "https://example.com/pricing",
  "customCode": "<iframe src=\"https://example.com\"></iframe>",
  "metadata": {
    "width": 123,
    "height": 123,
    "duration": 123,
    "pages": 123
  }
}
'

import requests

url = "https://api.dock.us/{version}/assets"

payload = {
    "type": "pdf",
    "name": "Sales deck",
    "fileId": "f9Ghw2n0Ju3D",
    "description": "<string>",
    "tagIds": ["RiHO4e0Ju3DS"],
    "isInternal": False,
    "url": "https://example.com/pricing",
    "customCode": "<iframe src=\"https://example.com\"></iframe>",
    "metadata": {
        "width": 123,
        "height": 123,
        "duration": 123,
        "pages": 123
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'pdf',
    name: 'Sales deck',
    fileId: 'f9Ghw2n0Ju3D',
    description: '<string>',
    tagIds: ['RiHO4e0Ju3DS'],
    isInternal: false,
    url: 'https://example.com/pricing',
    customCode: '<iframe src="https://example.com"></iframe>',
    metadata: {width: 123, height: 123, duration: 123, pages: 123}
  })
};

fetch('https://api.dock.us/{version}/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dock.us/{version}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'pdf',
    'name' => 'Sales deck',
    'fileId' => 'f9Ghw2n0Ju3D',
    'description' => '<string>',
    'tagIds' => [
        'RiHO4e0Ju3DS'
    ],
    'isInternal' => false,
    'url' => 'https://example.com/pricing',
    'customCode' => '<iframe src="https://example.com"></iframe>',
    'metadata' => [
        'width' => 123,
        'height' => 123,
        'duration' => 123,
        'pages' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.dock.us/{version}/assets"

	payload := strings.NewReader("{\n  \"type\": \"pdf\",\n  \"name\": \"Sales deck\",\n  \"fileId\": \"f9Ghw2n0Ju3D\",\n  \"description\": \"<string>\",\n  \"tagIds\": [\n    \"RiHO4e0Ju3DS\"\n  ],\n  \"isInternal\": false,\n  \"url\": \"https://example.com/pricing\",\n  \"customCode\": \"<iframe src=\\\"https://example.com\\\"></iframe>\",\n  \"metadata\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"duration\": 123,\n    \"pages\": 123\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dock.us/{version}/assets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"pdf\",\n  \"name\": \"Sales deck\",\n  \"fileId\": \"f9Ghw2n0Ju3D\",\n  \"description\": \"<string>\",\n  \"tagIds\": [\n    \"RiHO4e0Ju3DS\"\n  ],\n  \"isInternal\": false,\n  \"url\": \"https://example.com/pricing\",\n  \"customCode\": \"<iframe src=\\\"https://example.com\\\"></iframe>\",\n  \"metadata\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"duration\": 123,\n    \"pages\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dock.us/{version}/assets")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"pdf\",\n  \"name\": \"Sales deck\",\n  \"fileId\": \"f9Ghw2n0Ju3D\",\n  \"description\": \"<string>\",\n  \"tagIds\": [\n    \"RiHO4e0Ju3DS\"\n  ],\n  \"isInternal\": false,\n  \"url\": \"https://example.com/pricing\",\n  \"customCode\": \"<iframe src=\\\"https://example.com\\\"></iframe>\",\n  \"metadata\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"duration\": 123,\n    \"pages\": 123\n  }\n}"

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

{
  "data": {
    "asset": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "tags": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "object": "tag",
          "url": "https://api.dock.us/v1/tags/RiHO4e0Ju3DS",
          "title": "Logo"
        }
      ],
      "object": "asset",
      "url": "https://api.dock.us/v1/assets/RiHO4e0Ju3DS",
      "name": "Logo",
      "description": "Logo of the asset",
      "transcript": "<string>",
      "views": 100,
      "shares": 100,
      "assetType": "image",
      "assetUrl": "https://dock.us/logo.png",
      "isInternal": false
    }
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request could not be understood or was missing required parameters"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Access denied. You are not authorized to access this resource"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Access to this resource is restricted"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource could not be found"
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "The server has encountered a situation it does not know how to handle"
  }
}

Assets

Create an asset

Create an asset. For file-backed types (pdf, image, video, audio, docx, ppt, xlsx, htmlPage), first create a file via POST /files and PUT the bytes to its upload URL, then pass the file id here. Link and embed assets are created from a URL (or custom embed code) directly. Office documents (docx, ppt, xlsx) are converted to a PDF rendition asynchronously and are returned as the corresponding microsoft*EmbedPdf asset type — poll GET /files/ on the asset’s file to track conversion.

POST

assets

cURL

curl --request POST \
  --url https://api.dock.us/{version}/assets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "pdf",
  "name": "Sales deck",
  "fileId": "f9Ghw2n0Ju3D",
  "description": "<string>",
  "tagIds": [
    "RiHO4e0Ju3DS"
  ],
  "isInternal": false,
  "url": "https://example.com/pricing",
  "customCode": "<iframe src=\"https://example.com\"></iframe>",
  "metadata": {
    "width": 123,
    "height": 123,
    "duration": 123,
    "pages": 123
  }
}
'

import requests

url = "https://api.dock.us/{version}/assets"

payload = {
    "type": "pdf",
    "name": "Sales deck",
    "fileId": "f9Ghw2n0Ju3D",
    "description": "<string>",
    "tagIds": ["RiHO4e0Ju3DS"],
    "isInternal": False,
    "url": "https://example.com/pricing",
    "customCode": "<iframe src=\"https://example.com\"></iframe>",
    "metadata": {
        "width": 123,
        "height": 123,
        "duration": 123,
        "pages": 123
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'pdf',
    name: 'Sales deck',
    fileId: 'f9Ghw2n0Ju3D',
    description: '<string>',
    tagIds: ['RiHO4e0Ju3DS'],
    isInternal: false,
    url: 'https://example.com/pricing',
    customCode: '<iframe src="https://example.com"></iframe>',
    metadata: {width: 123, height: 123, duration: 123, pages: 123}
  })
};

fetch('https://api.dock.us/{version}/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dock.us/{version}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'pdf',
    'name' => 'Sales deck',
    'fileId' => 'f9Ghw2n0Ju3D',
    'description' => '<string>',
    'tagIds' => [
        'RiHO4e0Ju3DS'
    ],
    'isInternal' => false,
    'url' => 'https://example.com/pricing',
    'customCode' => '<iframe src="https://example.com"></iframe>',
    'metadata' => [
        'width' => 123,
        'height' => 123,
        'duration' => 123,
        'pages' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.dock.us/{version}/assets"

	payload := strings.NewReader("{\n  \"type\": \"pdf\",\n  \"name\": \"Sales deck\",\n  \"fileId\": \"f9Ghw2n0Ju3D\",\n  \"description\": \"<string>\",\n  \"tagIds\": [\n    \"RiHO4e0Ju3DS\"\n  ],\n  \"isInternal\": false,\n  \"url\": \"https://example.com/pricing\",\n  \"customCode\": \"<iframe src=\\\"https://example.com\\\"></iframe>\",\n  \"metadata\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"duration\": 123,\n    \"pages\": 123\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dock.us/{version}/assets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"pdf\",\n  \"name\": \"Sales deck\",\n  \"fileId\": \"f9Ghw2n0Ju3D\",\n  \"description\": \"<string>\",\n  \"tagIds\": [\n    \"RiHO4e0Ju3DS\"\n  ],\n  \"isInternal\": false,\n  \"url\": \"https://example.com/pricing\",\n  \"customCode\": \"<iframe src=\\\"https://example.com\\\"></iframe>\",\n  \"metadata\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"duration\": 123,\n    \"pages\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dock.us/{version}/assets")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"pdf\",\n  \"name\": \"Sales deck\",\n  \"fileId\": \"f9Ghw2n0Ju3D\",\n  \"description\": \"<string>\",\n  \"tagIds\": [\n    \"RiHO4e0Ju3DS\"\n  ],\n  \"isInternal\": false,\n  \"url\": \"https://example.com/pricing\",\n  \"customCode\": \"<iframe src=\\\"https://example.com\\\"></iframe>\",\n  \"metadata\": {\n    \"width\": 123,\n    \"height\": 123,\n    \"duration\": 123,\n    \"pages\": 123\n  }\n}"

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

{
  "data": {
    "asset": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "tags": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "object": "tag",
          "url": "https://api.dock.us/v1/tags/RiHO4e0Ju3DS",
          "title": "Logo"
        }
      ],
      "object": "asset",
      "url": "https://api.dock.us/v1/assets/RiHO4e0Ju3DS",
      "name": "Logo",
      "description": "Logo of the asset",
      "transcript": "<string>",
      "views": 100,
      "shares": 100,
      "assetType": "image",
      "assetUrl": "https://dock.us/logo.png",
      "isInternal": false
    }
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request could not be understood or was missing required parameters"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Access denied. You are not authorized to access this resource"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Access to this resource is restricted"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource could not be found"
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "The server has encountered a situation it does not know how to handle"
  }
}

See Uploading files for the end-to-end upload flow.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

properties

enum<string>[]

Select the asset properties that should be returned

Available options:

name,

description,

updatedAt,

createdAt,

views,

shares,

assetType,

assetUrl,

isInternal,

transcript,

tags.title,

tags.createdAt,

tags.updatedAt

Body

application/json

Asset to create

File-backed asset
Link asset
Embed asset from a URL
Embed asset from custom code

type

enum<string>

required

Type of asset to create

Available options:

pdf,

image,

video,

audio,

docx,

ppt,

xlsx,

htmlPage

Example:

"pdf"

name

string

required

Name of the asset

Example:

"Sales deck"

fileId

string

required

Id of an uploaded file (from POST /files). Required for pdf, image, video, audio, docx, ppt, xlsx and htmlPage assets. The file's bytes must already be uploaded, its mimeType must match the asset type, and it can only back one asset.

Example:

"f9Ghw2n0Ju3D"

description

string

Description of the asset

tagIds

string[]

Ids of existing tags to attach to the asset (create tags via POST /tags)

Example:

["RiHO4e0Ju3DS"]

isInternal

boolean

default:false

Whether the asset is for internal use only

url

string

Source URL. Required for link assets; for embed assets provide either url or customCode (not both).

Example:

"https://example.com/pricing"

customCode

string

Custom embed HTML. Only for embed assets, mutually exclusive with url.

Example:

"<iframe src=\"https://example.com\"></iframe>"

metadata

object

Optional media metadata for file-backed assets. The server extracts pdf/image metadata automatically when omitted; video/audio dimensions and duration can only come from the caller.

Show child attributes

Response

Asset created

data

object

Show child attributes

API Reference

Clients

Workspaces

Library

General

Create an asset

Authorizations

Query Parameters

Body

Response