DOdovetail
Files

Upload a file (deprecated)

Changed on

Deprecated — use the v2 upload endpoints for new integrations: POST /v2/files/upload for files up to 5 GB and POST /v2/files/large-upload for files up to 10 GB. This endpoint is capped at 100 MB.

Existing callers keep working. Each response carries a Deprecation: true header and a Link header pointing at the successor. A sunset date will be announced once v2 adoption is broad.

Upload a file for embedding in docs, data entries, or insights. The request must use multipart/form-data encoding with a single file field containing the file data.

After uploading, use the returned file ID to reference the file in document content (e.g. as a cover image via cover_image_file_id on the Create doc or Patch doc endpoints).

Limits: Maximum file size is 100 MB. Orphaned files that are not embedded in any document within 24 hours are automatically cleaned up.

Returns the file metadata including its processing status.

Required scope: doc:file_import

post/v1/files/

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/files/
  • Auth
    HTTP bearer

Request body multipart/form-data

fileunknown

Response

201

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status