Import file to data

Create a new data entry from a file. Provide the file in exactly one of two ways:

  • url — a publicly accessible URL that Dovetail downloads and imports, or
  • file_id — the id of a file you have already uploaded via the file upload API (the upload must be complete).

The data entry must be associated with a project via project_id. Supported file types include documents (PDF, DOCX), audio files (MP3, WAV, M4A), and video files (MP4, MOV).

If the file is audio or video, Dovetail will automatically queue it for transcription. The resulting transcript will be added to the data body once processing completes.

When importing from url, optionally set created_at to backdate the entry and author_id to attribute it to a specific user. These, along with mime_type, are ignored when importing by file_id (the file already carries its own metadata).

Returns the newly created data object (without content).

🚧

Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

🚧

Supported URLs

Only publicly accessible URLs that link directly to a downloadable file are supported. If the URL does not include a file extension, you must provide the mime_type parameter so Dovetail can determine how to process the file.

🚧

Fields

Only existing and unique fields can be referenced. This endpoint will not create new fields, or attempt to differentiate between duplicate field labels.

📘

Transcription notifications

When a transcription completes or fails, the account linked to the API token will receive a notification. You can manage notification preferences in notification settings.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body

fields
array of objects

The data's fields.

fields
string

The nature and format of the file you want to import. Only used when importing from url.

string
required

Unique identifier of the project that the data is associated with.

string
required

The data's title.

uri

Public url to the file that you want to import. Provide exactly one of url or file_id.

string

Unique identifier of a file already uploaded via the file upload API. The upload must be complete. Provide exactly one of url or file_id.

string

The creation date and time to associate with the file, in ISO 8601 format. Only used when importing from url.

string

Unique identifier of the Dovetail user that the file is associated with. Only used when importing from url.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json