> ## Documentation Index
> Fetch the complete documentation index at: https://developers.dock.us/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a file
> Create a file and receive a presigned upload URL. PUT the raw file bytes to the returned upload URL (with the matching Content-Type header), then pass the file id to POST /assets to create an asset from it.
export const RateLimit = ({perMinute = 120}) =>
This endpoint is rate limited to {perMinute} requests per minute per
company. See Rate limits for details.
;
## OpenAPI
````yaml post /files
openapi: 3.1.0
info:
title: Dock API
description: >-
The Dock API is a RESTful API that allows you to interact with Dock in a
programmatic way
termsOfService: https://www.dock.us/legal/terms
contact:
name: API Support
email: developers@dock.us
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0
servers:
- url: https://api.dock.us/{version}
description: Production server
variables:
version:
default: v1
enum:
- v1
security:
- bearerAuth: []
tags:
- name: Status check
description: API to check if the API is up
- name: Accounts
description: API to manage accounts
- name: Assets
description: API to manage assets
- name: Asset share links
description: API to retrieve asset share links
- name: Files
description: API to manage files
- name: Forms
description: API to retrieve forms and their responses
- name: Meetings
description: API to manage meetings and call transcripts
- name: Tags
description: API to manage tags
- name: Users
description: API to manage users
- name: Workspaces
description: API to manage workspaces
- name: Templates
description: API to manage templates
- name: Workspace pages
description: API to manage workspace pages
- name: Workspace plans
description: API to manage workspace plans
- name: Workspace plan tasks
description: API to manage workspace plan tasks
- name: Workspace sections
description: API to manage workspace sections
paths:
/files:
post:
tags:
- Files
description: >-
Create a file and receive a presigned upload URL. PUT the raw file bytes
to the returned upload URL (with the matching Content-Type header), then
pass the file id to POST /assets to create an asset from it.
requestBody:
description: File to create
required: true
content:
application/json:
schema:
type: object
required:
- fileName
- mimeType
properties:
fileName:
type: string
description: Name of the file, including its extension
example: contract.pdf
mimeType:
type: string
description: MIME type of the file to upload
enum:
- application/pdf
- image/jpeg
- image/png
- image/gif
- image/webp
- video/mp4
- video/webm
- video/quicktime
- video/mov
- video/mpeg
- video/mpg
- video/avi
- audio/mpeg
- audio/mp3
- audio/wav
- audio/ogg
- audio/m4a
- >-
application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/msword
- >-
application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/vnd.ms-powerpoint
- >-
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- application/vnd.ms-excel
- text/html
example: application/pdf
size:
type: integer
minimum: 1
description: >-
File size in bytes. Validated against the per-type upload
limit: 50MB for images and audio, 150MB for office documents
and HTML, 500MB for PDFs, 10GB for videos.
example: 24576
responses:
'200':
description: File created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
file:
$ref: '#/components/schemas/File'
upload:
$ref: '#/components/schemas/FileUploadTarget'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
components:
schemas:
File:
allOf:
- $ref: '#/components/schemas/BaseObject'
- type: object
properties:
object:
type: string
description: Type of the object
enum:
- file
example: file
readOnly: true
name:
type: string
description: Name of the file
example: contract.pdf
nullable: true
thumbnail:
type: string
description: Thumbnail URL for the file when available
example: >-
https://storage.googleapis.com/dock-production-private/thumbnails/contract.png
nullable: true
size:
type: integer
description: File size in bytes
example: 24576
nullable: true
url:
type: string
description: Download URL for the file
example: >-
https://storage.googleapis.com/dock-production-private/signed-url
nullable: true
expiresAt:
type: string
format: date-time
description: URL expiry timestamp for signed private file URLs
example: '2026-06-12T12:00:00.000Z'
nullable: true
uploadStatus:
type: string
description: >-
Upload/processing state of the file. Files created via POST
/files stay `in_progress` until their bytes are uploaded and an
asset is created from them; converted office files stay
`in_progress` until conversion completes.
enum:
- success
- in_progress
- failed
example: success
nullable: true
mimeType:
type: string
description: MIME type of the file
example: application/pdf
nullable: true
FileUploadTarget:
type: object
description: >-
Presigned upload target. Send the raw file bytes in a PUT request to
`url` with the returned `Content-Type` header before the link expires.
properties:
url:
type: string
description: Presigned Google Cloud Storage upload URL
example: >-
https://storage.googleapis.com/dock-production-private/asset/abc123/6f1b.pdf?X-Goog-Signature=...
method:
type: string
enum:
- PUT
example: PUT
headers:
type: object
description: >-
Headers that must be sent with the upload request. The Content-Type
must match the mimeType the file was created with.
properties:
Content-Type:
type: string
example: application/pdf
expiresAt:
type: string
format: date-time
description: Timestamp after which the upload URL is no longer valid (1 hour)
example: '2026-06-12T12:00:00.000Z'
BaseObject:
type: object
properties:
id:
$ref: '#/components/schemas/Id'
updatedAt:
type: string
format: date-time
description: Last updated date
example: '2021-01-01T00:00:00.000Z'
readOnly: true
createdAt:
type: string
format: date-time
description: Created at date
example: '2021-01-01T00:00:00.000Z'
readOnly: true
Id:
type: string
description: Id of the object
example: RiHO4e0Ju3DS
readOnly: true
responses:
'400':
description: >-
The server cannot or will not process the request due to something that
is perceived to be a client error (e.g., malformed request syntax,
invalid request message framing, or deceptive request routing)
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- BAD_REQUEST
description: A short code indicating the error code returned
example: BAD_REQUEST
message:
type: string
description: A human readable explanation of what went wrong
example: >-
The request could not be understood or was missing
required parameters
required:
- code
- message
required:
- error
'401':
description: >-
Although the HTTP standard specifies "unauthorized", semantically this
response means "unauthenticated". That is, the client must authenticate
itself to get the requested response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- UNAUTHORIZED
description: A short code indicating the error code returned
example: UNAUTHORIZED
message:
type: string
description: A human readable explanation of what went wrong
example: >-
Access denied. You are not authorized to access this
resource
required:
- code
- message
required:
- error
'403':
description: >-
The client does not have access rights to the content; that is, it is
unauthorized, so the server is refusing to give the requested resource.
Unlike 401 Unauthorized, the client's identity is known to the server
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- FORBIDDEN
description: A short code indicating the error code returned
example: FORBIDDEN
message:
type: string
description: A human readable explanation of what went wrong
example: Access to this resource is restricted
required:
- code
- message
required:
- error
'404':
description: The server cannot find the requested resource
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- NOT_FOUND
description: A short code indicating the error code returned
example: NOT_FOUND
message:
type: string
description: A human readable explanation of what went wrong
example: The requested resource could not be found
required:
- code
- message
required:
- error
'429':
description: >-
The user has sent too many requests in a given amount of time ("rate
limiting")
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- RATE_LIMIT_EXCEEDED
description: A short code indicating the error code returned
example: RATE_LIMIT_EXCEEDED
message:
type: string
description: A human readable explanation of what went wrong
example: Rate limit exceeded. Please try again later
required:
- code
- message
required:
- error
'500':
description: The server has encountered a situation it does not know how to handle
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- INTERNAL_SERVER_ERROR
description: A short code indicating the error code returned
example: INTERNAL_SERVER_ERROR
message:
type: string
description: A human readable explanation of what went wrong
example: >-
The server has encountered a situation it does not know
how to handle
required:
- code
- message
required:
- error
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````