# Dovetail integration

> Customer research and insights platform: projects, notes, highlights, tags, docs, channels, contacts, and search.

- Authentication: apiKey

## Tools (94)

- **Add project context doc**: Add an insight to the project's AI context. A project can have at most 10 context docs. If the insight is already linked, this is a no-op.
- **Add project context keywords**: Add one or more keywords to the project's AI context. Duplicate keywords are ignored.
- **Add utterance**: Add a finalised utterance to a data entry's transcript and broadcast it to connected clients. If the entry has no transcript, one is created automatically.
- **Add workspace context doc**: Add an insight to the workspace's AI context. A workspace can have at most 10 context docs. If the insight is already linked, this is a no-op.
- **Apply tags to highlight**: Apply one or more tags (up to 10 per request) to a highlight. Tags are labels used to categorize highlights during qualitative analysis (e.g. "Usability Issue", "Feature Request").
- **Attach audio**: Attach an already-uploaded audio file to the live transcript on a data entry. The transcript node currently being written to via `appendLiveTranscriptUtterance` or `setLiveTranscript` is wrapped in an audio/video block carrying the supplied `file_id`, giving the editor audio playback + transcript-sync.
- **Create channel**: Create a new channel in your workspace. A channel is an automated pipeline for analyzing customer feedback at scale. You must specify a `content_type` (e.g. `APP_REVIEW`, `NPS_FEEDBACK`, `SUPPORT_TICKETS`) that tells Dovetail what kind of data will flow through this channel.
- **Create contact**: Create a new contact in your workspace's contacts database. Provide a name and email, and optionally attach custom field data (e.g. a Salesforce ID or company name).
- **Create data**: Create a new data entry within a Dovetail project. Data entries capture raw research data — interview transcripts, survey responses, support tickets, or CRM records.
- **Create data point**: Send a new data point to a channel for automated AI analysis. Each data point represents a single piece of customer feedback (e.g. an app review, a support ticket, or an NPS response).
- **Create data point on a dataset**: Send a new data point to a dataset, without it having to belong to a channel.
- **Create doc**: Create a new doc in your Dovetail workspace. Docs are rich-text documents used to write up research reports, share findings, and publish deliverables.
- **Create doc comment**: Create a comment on a doc.
- **Create field**: Create a field in a project or workspace field group.
- **Create folder**: Create a new folder in your Dovetail workspace. Folders organize projects, docs, channels, and other content into a hierarchical structure.
- **Create note**: Create a new data entry (note) within a Dovetail project. Data entries capture raw research data — interview transcripts, survey responses, or session recordings.
- **Create project**: Create a new project in your Dovetail workspace. Projects are the primary container for organizing research — they hold data, docs, highlights, tags, and insights.
- **Create tag**: Create a new tag. Tags are labels used to categorize highlights — for example "Usability Issue", "Feature Request", or "Positive Feedback".
- **Create topic**: Create a new topic within a channel. Topics are categories used by Dovetail's AI to classify incoming data points. Each topic has a title and description that guide how data is sorted.
- **Create transcript highlight**: Create a highlight on a transcript by specifying start and end timestamps in seconds.
- **Delete channel**: Delete a channel.
- **Delete contact**: Delete a contact.
- **Delete data**: Delete a data.
- **Delete doc**: Delete a doc.
- **Delete doc comment**: Delete a comment on a doc.
- **Delete field**: Delete a field by id. This is a soft delete.
- **Delete folder**: Delete a folder.
- **Delete note**: Delete a note. The note is soft-deleted and moved to the project's trash, but can be restored for up to 30 days before they’re automatically and permanently deleted.
- **Delete project**: Delete a project.
- **Delete topic**: Delete a topic.
- **Download a file**: Get a presigned URL to download the content of a file by its unique identifier.
- **Export data**: Export the content body of a data entry in either HTML or Markdown format. Use the `type` path parameter to specify the desired format: `html` or `markdown`.
- **Export doc**: Export the content body of a doc in either HTML or Markdown format. Use the `type` path parameter to specify the desired format: `html` or `markdown`.
- **Export note**: Export the content body of a data entry (note) in either HTML or Markdown format. Use the `type` path parameter to specify the desired format: `html` or `markdown`.
- **Finalize a large (multipart) file upload**: Finalize an upload session created by **Initiate large upload** (`POST /v2/files/large-upload`). The `parts` array must include every part that was uploaded, with the `etag` returned by the storage backend for each part `PUT`.
- **Finalize a single-PUT file upload**: Finalize an upload session created by **Initiate single-PUT upload** (`POST /v2/files/upload`). The server `HEAD`s the S3 object to confirm bytes are present and that the size matches the declared value, then flips the file row to `DONE`.
- **Get channel**: Retrieve a single channel's metadata by its unique identifier. Returns title, creation date, folder location, and a list of its topics (AI-generated categories used to classify incoming data points).
- **Get contact**: Retrieve a single contact by its unique identifier. Contacts represent people in your contacts database (e.g. interview participants, customers, or research subjects).
- **Get data**: Retrieve a single data entry by its unique identifier.
- **Get data point**: Get a data point by id.
- **Get doc**: Retrieve a single doc by its unique identifier. The response is **metadata only** with respect to the document body: it includes title, custom fields, project reference, folder, files, and cover image, but **not** the rich-text **content body**.
- **Get doc comment**: Get a comment on a doc by id.
- **Get field**: Get a field by id.
- **Get file by id**: Retrieve metadata for a single file by its unique identifier. Returns the file's name, MIME type, size in bytes, processing status (`pending`, `completed`, or `failed`), author, and creation date.
- **Get folder**: Retrieve a single folder by its unique identifier. Returns the folder's metadata including title, parent folder, creation date, and a list of immediate child folder IDs.
- **Get folder contents**: Retrieve all items contained within a specific folder. Returns a paginated list of projects, docs, channels, dashboards, agents, and child folders that are direct children of the specified folder.
- **Get highlight**: Retrieve a single highlight by its unique identifier. Returns the highlight's text content, associated data entry, tags, and time range (for transcript highlights).
- **Get note**: Retrieve a single data entry (note) by its unique identifier. Returns the entry's full metadata including title, custom fields, associated project, folder, and attached files.
- **Get project**: Retrieve a single project by its unique identifier. Returns the project's metadata including title, author, creation date, folder location, and overview content in Markdown format.
- **Get project context**: Retrieve the AI context for a project, including its keywords and linked insight docs.
- **Get tag**: Retrieve a single tag by its unique identifier. Returns the tag's title, scope (`project` or `workspace`), the project it belongs to, its workspace tag board (for workspace tags), and its creation date.
- **Get user**: Retrieve a single workspace member by their unique identifier. Returns the user's profile information including name, email, job title, role (CONTRIBUTOR, MANAGER, or VIEWER), and whether they are a workspace admin.
- **Get workspace context**: Retrieve the AI context for the workspace: linked insight docs used as source material for workspace-wide AI features.
- **Import file to data**: Create a new data entry from a file. Provide the file in **exactly one** of two ways:
- **Import file to doc**: Create a new doc by importing a file. Provide the file in **exactly one** of two ways:
- **Import file to note**: Create a new data entry (note) by importing a file from a publicly accessible URL. The entry must be associated with a project via `project_id`.
- **Initiate a large (multipart) file upload**: Initiate a multipart upload for files **up to 10 GB**. The response includes an opaque `upload_id` and a fully populated `urls` array containing one pre-signed `PUT` URL per part the client should upload.
- **Initiate a single-PUT file upload**: Initiate a single-PUT upload for files **up to 5 GB**. The response includes a pre-signed `upload_url` that the client should `PUT` the full file body to.
- **Link workspace field group**: Link a workspace field group to a project so the group's fields are available on that project's data and docs. For callers with write permission, linking the same group twice is a no-op.
- **List channel data points**: Get a list of data points for a channel.
- **List channels**: Retrieve all channels in your workspace. Channels are automated analysis pipelines that continuously process high-volume unstructured customer feedback (e.g. app reviews, NPS responses, support tickets) into structured, categorized insights using AI-powered topic classification.
- **List channel themes**: Retrieve all themes for a channel. Themes are AI-generated clusters of data points that share a common subject within a topic.
- **List contacts**: Retrieve all contacts in your workspace's contacts database. Contacts represent people such as interview participants, customers, or research subjects.
- **List data**: Retrieve all data entries in your workspace. Data entries are documents within a project that capture raw research data such as interview transcripts, survey responses, support tickets, and session recordings.
- **List doc comments**: Get a list of page-level and inline comments on a doc.
- **List docs**: Retrieve all docs in your workspace. Docs are rich-text documents used to write up research reports, share findings, and publish deliverables.
- **List fields**: Get a list of fields for a project or workspace field group.
- **List folders**: Retrieve all folders in your workspace. Folders are used to organize projects, docs, channels, dashboards, agents, and other folders into a hierarchical structure — similar to a file system.
- **List highlights**: Retrieve all highlights in your workspace. Highlights are selected passages of text (or time ranges in audio/video transcripts) within data entries that have been marked as significant during qualitative analysis.
- **List notes**: Retrieve all data entries (notes) in your workspace. These are documents within a project that capture raw research data such as interview transcripts, survey responses, and session recordings.
- **List projects**: Retrieve all projects in your workspace. Projects are containers for organizing qualitative research — they hold data, docs, highlights, tags, and insights related to a specific research initiative.
- **List project templates**: Retrieve all project templates available in your workspace. Templates are reusable blueprints that define a project's fields, views, tags, and structural layout.
- **List tag boards**: Retrieve tag boards in your workspace. A tag board holds the tags (and tag groups) used to categorize highlights — every project has its own board, and a workspace can additionally have workspace tag boards whose tags are shared across all projects linked to them.
- **List tags**: Retrieve all tags in your workspace. Tags are labels used to categorize highlights during qualitative analysis (e.g. "Usability Issue", "Feature Request", "Positive Feedback").
- **List users**: Retrieve all members of your workspace. Returns each user's profile information including name, email, job title, role, and admin status.
- **Magic Search**: Perform a full-text search across your workspace's content. Returns matching highlights, data (notes), insights, channels, tags, and themes in a single response.
- **Magic Summarize**: Generate an AI-powered summary from a collection of highlights, data entries (notes), insights, themes, and/or tags. Provide one or more arrays of IDs and Dovetail will synthesize the content into a concise summary.
- **Patch channel**: Update a channel's properties. Supports updating the title and the context (a description of the channel's main goal or purpose, which helps Dovetail's AI better classify incoming data).
- **Patch data**: Update a data entry's properties. Supports updating the title and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged.
- **Patch doc**: Update a doc's properties. Supports updating the title, custom fields, cover image, and folder location. Only the fields you include in the request body will be modified — omitted fields are left unchanged.
- **Patch folder**: Update a folder's properties. Currently supports updating the folder title. Only the fields you include in the request body will be modified.
- **Patch note**: Update a data entry's (note's) properties. Supports updating the title and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged.
- **Patch project**: Update a project's properties. Currently supports updating the project title. Only the fields you include in the request body will be modified.
- **Patch topic**: Update a topic's title and/or description. Only the fields you include in the request body will be modified — omitted fields are left unchanged.
- **Remove project context doc**: Remove an insight from the project's AI context. If the insight is not linked, this is a no-op.
- **Remove project context keywords**: Remove one or more keywords from the project's AI context. Keywords not present in the current list are ignored.
- **Resolve doc comment thread**: Resolve the comment thread on a doc. This marks the conversation as resolved.
- **Search V2**: Perform an advanced search across your entire Dovetail workspace. This is the recommended search endpoint, supporting all content types: agents, highlights, data (notes), insights, channels, dashboards, tags, themes, projects, folders, and people (contacts).
- **Set transcript from download URL**: Create or replace a data entry's live transcript by fetching a Recall async transcript JSON from `download_url`, mapping participant names to speaker labels, and writing the result in a single commit.
- **Token info**: Retrieve information about the API token used to authenticate this request. Use this endpoint to verify that your token is valid and to determine which workspace it belongs to.
- **Unresolve doc comment thread**: Unresolve the comment thread on a doc. This reopens the conversation.
- **Update contact**: Update an existing contact's properties. Supports updating the name, email, and custom fields. Only the fields you include in the request body will be modified — omitted fields are left unchanged.
- **Update doc comment**: Update a comment on a doc.
- **Update field**: Update a field by id.

Connect Dovetail in General Input: https://www.generalinput.com/apps/dovetail