Skip to main content
Harvey logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 35
  • Triggers: 0
  • Slug: HARVEY
  • Version: 00000000_00

Tools

Slug: HARVEY_ADD_REVIEW_TABLE_ROWAdd one processed file or a group of processed files to a Harvey review table and schedule asynchronous review processing. A successful response confirms scheduling, not completion. This contract is documentation-derived and has not been live-verified.

Input Parameters

array
required
Processed file IDs from the review table’s Vault project to add as one row. Two or more files are reviewed together as a file group. Harvey’s default per-request limit is 25 files.
string
Optional name for a group of two or more files. Omit it to use the first file’s name; Harvey ignores it for a single-file row.
integer
required
Integer identifier of the review table to add the row to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_CREATE_AGENT_THREADStart an asynchronous Harvey agent run from a prompt and optional documents. The documented contract and permissions have not been live-verified; use Get Agent Thread with the returned id to retrieve the final result.

Input Parameters

array
Documents for the agent to read. Supply at most 50 files; each file and the combined upload must be at most 100 MB.
string
required
Task or question for the selected agent, from 1 to 4,000 characters.
string
required
Published agent UUID to run.
string
Client matter UUID or name for attribution. Some Harvey workspaces require a client matter on every query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_CREATE_ASSISTANT_COMPLETIONGenerate one non-streaming Harvey Assistant response from a prompt with optional documents or knowledge sources, matter attribution, model selection, and citations. This API requires an additional paid workspace purchase. Its documented contract and permissions have not been live-verified.

Input Parameters

string ("draft" | "assist")
Assistant behavior mode. Omit to use Harvey’s default mode.
array
Documents for Assistant to analyze. Files cannot be combined with knowledge_sources in the same request.
string ("gpt-5" | "gpt-5-1" | "gpt-5-2" | "gpt-5-4" | "gpt-5-4-mini" | "gpt-5-5" | "gpt-4-1" | "claude-opus-4-5" | "claude-sonnet-4-5" | "claude-opus-4-6" | "claude-opus-4-7")
Harvey customer-facing model slug. Omit to use the workspace default.
string
required
Legal task or question for Harvey Assistant, up to 20,000 characters.
string
Client matter UUID to associate with this completion.
boolean
Whether Harvey should include inline citations and source details. Disabling citations can return a response more quickly.
array
Vault, web, or regional knowledge sources to query. Knowledge sources cannot be combined with uploaded files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_CREATE_HISTORY_FILE_DOWNLOAD_URLSCreate time-limited pre-signed download URLs for file IDs returned by Harvey query-history exports. The URLs grant temporary file access and must be treated as secrets: use them promptly and do not log, publish, or share them. This operation’s API-token permission is not specified by Harvey, and the contract has not been live-verified.

Input Parameters

array
required
History file UUIDs returned by a Harvey query-history export. At least one ID is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_CREATE_INTAKE_REQUESTSubmit an idempotent request and optional documents to the Harvey Intake queue. A new request returns HTTP 201 and a replay of the caller-provided idempotency key returns the original request with HTTP 200. This documented contract and its permissions have not been live-verified.

Input Parameters

array
Documents concerning the request. Supply at most 50 files; most accepted file types may be up to 100 MB each.
string
required
Short title for the Intake request, from 1 to 255 characters.
string
Detailed instructions for the Intake team, up to 10,000 characters.
string
required
Caller-chosen identifier unique within the workspace. Reuse the exact same value to safely replay a submission without creating a duplicate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_CREATE_VAULT_PROJECTCreate a Harvey Vault project or knowledge base, optionally attributed to a client matter. This documented contract and its permissions have not been live-verified.

Input Parameters

string
required
Name for the new Vault project.
string
Optional client matter identifier for attribution.
boolean
Whether to create the project as a knowledge base.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_DELETE_MATTERSIdempotently soft-delete 1 to 10,000 Harvey matters by firm client and matter identifiers. Inspect deleted, already_absent, and errors even on HTTP 200 because a batch can partially succeed. The parent clients and historical queries remain. This contract is documentation-derived and has not been live-verified.

Input Parameters

array
required
Client and matter identifier pairs to soft-delete. Harvey processes each pair into deleted, already_absent, or errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_DELETE_VAULT_FILEPermanently delete one file from a Harvey Vault project. WARNING: this is a destructive operation and the file cannot be recovered through this action. Harvey may complete deletion asynchronously, so a successful response can confirm acceptance rather than immediate removal. The response preserves any operation or status identifier for follow-up. This contract is documentation-derived and has not been live-verified.

Input Parameters

string
required
Unique identifier of the Vault file to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_DELETE_VAULT_PROJECTMove an entire Harvey Vault project and all its contents to the workspace recycle bin. This is destructive and processing continues asynchronously after Harvey accepts the request, so the response does not prove completion. Confirm the project ID and intended contents before calling. This contract and its permissions are documentation-derived and have not been live-verified.

Input Parameters

string
required
Unique identifier of the Vault project to move to the recycle bin with all its contents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_EXPORT_QUERY_HISTORYExport enriched query history for a UTC epoch window of at most 30 days, optionally including related file IDs. Warning: results contain sensitive workspace-wide resource names, prompts, and AI outputs and are not restricted by client-matter or ethical-wall boundaries. Share results and API tokens carefully. Harvey limits History Export endpoints to two requests per minute. This documented contract has not been live-verified.

Input Parameters

integer
required
UTC epoch end time, after start_time and at most 30 days later.
integer
required
Inclusive UTC epoch start time, no more than one year ago.
boolean
Whether to include related file IDs and metadata for later download URL resolution. Enabling this may reduce performance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_EXPORT_USAGE_HISTORYExport enriched Harvey workspace usage events for a UTC epoch range of at most 30 days, optionally including related file IDs. The data may contain sensitive resource names across the entire workspace and is not bounded by client-matter or ethical-wall access. Harvey limits History Export endpoints to 2 requests per minute. This contract is documentation-derived and has not been live-verified.

Input Parameters

integer
required
Exclusive UTC epoch end time. It must be after start_time and no more than 30 days later.
integer
required
Inclusive UTC epoch start time, no more than one year ago.
boolean
Whether to include file IDs and per-file metadata. Enabling this may reduce response performance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_AGENTReturn metadata for one reachable published Harvey agent. Use this before starting a run to confirm the agent remains available and identify its current published version. This contract is documentation-derived and not live-verified.

Input Parameters

string
required
Published agent UUID, typically returned by HARVEY_LIST_AGENTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_AGENT_THREADRead one Harvey agent thread status and any available answer, citations, generated files, or error. This contract is documentation-derived and has not been live-verified.

Input Parameters

integer
required
Agent thread ID returned by Create Agent Thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_CURRENT_USERReturn the Harvey service-user identity associated with the connected API token. Harvey documents this as its authentication-test endpoint but does not document whether it needs a configurable token permission. No no-permission claim is made, and this has not been live-verified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_EARLIEST_AUDIT_LOGReturn the earliest available Harvey audit log, optionally filtered by log type. Use its ID to begin forward audit-log traversal. This contract is documentation-derived and has not been live-verified.

Input Parameters

string
Harvey audit event type to match, if filtering to one type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_INTAKE_REQUESTRead one Harvey Intake request’s lifecycle state, assignment, timestamps, and attachments. This contract is documentation-derived and has not been live-verified.

Input Parameters

string
required
Intake request UUID returned by HARVEY_CREATE_INTAKE_REQUEST.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_LATEST_AUDIT_LOGReturn the latest available Harvey audit log, optionally for one log type. This contract is documentation-derived and has not been live-verified.

Input Parameters

string
Harvey audit event type to match, if filtering to one type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_REVIEW_TABLEReturn a Harvey review table’s title, creation time, and associated file IDs. This contract is documentation-derived and has not been live-verified.

Input Parameters

integer
required
Integer review table ID returned by HARVEY_GET_VAULT_PROJECT metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_REVIEW_TABLE_ROWReturn a Harvey review-table row and its cell results for one file. Files in a group resolve to the shared row. This contract is documentation-derived and has not been live-verified.

Input Parameters

string
required
File ID associated with the review table. For a file group, any member file ID resolves to the group’s row.
integer
required
Integer review table ID returned by HARVEY_GET_REVIEW_TABLE or HARVEY_GET_VAULT_PROJECT.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_VAULT_FILESReturn details and processing status for up to 1,000 Harvey Vault file IDs. Files that are missing or inaccessible are returned as records with an error instead of file details. This contract is documentation-derived and has not been live-verified.

Input Parameters

array
required
Vault file identifiers whose details and processing status should be returned (1-1000 IDs). Values are sent as repeated file_ids query parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_GET_VAULT_PROJECTReturn a Harvey Vault project’s metadata, file identifiers and names, review tables, and storage limits. This contract, including the provider’s unusual HTTP 201 success response for a GET request, is documentation-derived and has not been live-verified.

Input Parameters

string
required
Vault project identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_LIST_AGENTSList published Harvey agents available to the connected service user, one cursor page at a time. This contract is documentation-derived and has not been live-verified.

Input Parameters

integer
Maximum agents to return in this page (1-100). Harvey clamps out-of-range values.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_LIST_AUDIT_LOGSPage forward through Harvey audit logs from a starting log ID, optionally filtered by log type. Continuation advances from the last returned log ID. This pagination contract is documentation-derived and has not been live-verified; the inclusive or exclusive boundary behavior must be confirmed to rule out duplicate rows.

Input Parameters

integer
required
Maximum audit log entries to return in this page (1-1000).
string
Opaque continuation cursor returned by a previous call; provide this or starting_log_id.
string
Harvey audit event type to match, if filtering to one type.
string
Starting audit-log ID for the first page; provide this or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_LIST_CLIENT_MATTERSReturn all Harvey client matters, including deleted records and usage statistics. This unpaginated contract is documentation-derived and has not been live-verified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_LIST_RECYCLED_VAULT_PROJECTSList Vault projects currently in the workspace recycle bin, optionally filtered by project-name text or client matter. Results retain Harvey’s newest-deletion-first order. This contract is documentation-derived and has not been live-verified.

Input Parameters

string
Case-insensitive substring to match against recycled Vault project names.
string
Client matter UUID whose recycled Vault projects should be returned; this is not the human-readable matter number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_LIST_VAULT_PROJECT_FILESList, filter, and sort files in a Harvey Vault project, one cursor page at a time. The response and pagination contract is documentation-derived and has not been live-verified.

Input Parameters

string
Case-insensitive substring to match in file names. Percent and underscore characters are treated literally.
integer
Maximum files to return in this page (1-100).
string
Opaque continuation cursor returned by a previous call. It preserves the project, filters, page size, and sort options from that call.
string ("name" | "uploaded_at" | "size")
File field used to sort results.
string
required
Unique identifier of the Vault project.
string ("asc" | "desc")
Sort files in ascending or descending order.
array
MIME content types to include (up to 20). Values are sent as repeated content_type query parameters.
integer
Inclusive lower bound on upload time as a UTC Unix timestamp in seconds; must be earlier than uploaded_before.
integer
Inclusive upper bound on upload time as a UTC Unix timestamp in seconds.
array
Harvey processing statuses to include (up to 20). Values are sent as repeated processing_status query parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_LIST_VAULT_PROJECTSList and filter workspace Vault projects and knowledge bases, one page at a time. The response and pagination contract is documentation-derived and has not been live-verified.

Input Parameters

string
Case-insensitive substring to match against project names.
integer
Page number to fetch when no continuation cursor is supplied.
string
Opaque continuation cursor returned by a previous call. When supplied, its page and original filters override other pagination inputs.
string ("date" | "name")
Project field used for sorting: date uses the last content-update timestamp and name sorts alphabetically.
integer
Maximum projects to return in this page (1-100).
string ("asc" | "desc")
Sort projects in ascending or descending order.
integer
Inclusive lower bound on project creation time as a UTC Unix timestamp in seconds; must be earlier than created_before.
integer
Exclusive upper bound on project creation time as a UTC Unix timestamp in seconds.
boolean
Filter to knowledge-base projects when true or ordinary Vault projects when false; omit to return both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_LIST_VAULT_PROJECT_USERSList workspace users with direct or inherited effective access to a Harvey Vault project. The project owner is included with MANAGE access, and provider-returned access-origin, inherited-access, and owner indicators are preserved when present. Requires Vault API plus either Vault sharing (view only) or Vault sharing permission. This response contract and permission behavior are documentation-derived and have not been live-verified.

Input Parameters

string
required
Unique UUID of the Vault project whose effective user access to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_REMOVE_VAULT_PROJECT_USERSRemove direct WORKSPACE_USER shares from a Harvey Vault project by email. Inherited access through workspace, group, or space shares remains effective. Inspect both removed and failed because individual emails can fail without rejecting the entire request. This contract is documentation-derived and has not been live-verified.

Input Parameters

array
required
Workspace-user email addresses whose direct WORKSPACE_USER shares should be removed. Inherited workspace, group, or space access is unaffected.
string
required
Unique identifier of the Vault project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_SEARCH_AUDIT_LOGS_BY_TIMEReturn the first Harvey audit log at or after a UTC epoch timestamp, optionally filtered by log type. This contract is documentation-derived and has not been live-verified.

Input Parameters

integer
required
UTC epoch timestamp no more than one year old.
string
Harvey audit event type to match, if filtering to one type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_SEARCH_VAULTReturn semantically relevant document chunks from one Harvey Vault project. The response is ordered by relevance and can optionally include source file names. This contract has not been live-verified.

Input Parameters

string
required
Natural-language semantic search query.
string
required
UUID of the Vault project to search.
boolean
Whether each result chunk should include the source file’s display name. A returned file_name can still be null if the file was deleted after indexing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_UPDATE_VAULT_PROJECT_USERSAdd workspace users or update their direct access level on a Harvey Vault project. This is an additive partial update: users omitted from the request remain unchanged, and the project owner must not be included. Inspect failed even on HTTP 200 because individual user updates can fail. This contract and its permissions are documentation-derived and have not been live-verified.

Input Parameters

array
required
Workspace users to add or update. Users omitted from this list remain unchanged; do not include the project owner.
string
required
Unique identifier of the Vault project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_UPLOAD_VAULT_FILESUpload up to 50 new or replacement files to a Harvey Vault project. Optional Vault paths correspond positionally to the uploaded files, and duplicate_mode controls filename collisions. The provider returns HTTP 201. This documented contract and its permissions have not been live-verified.

Input Parameters

array
required
Files to upload or replace in the Vault project (1-50 files).
array
Optional Vault paths corresponding positionally to files. When supplied, provide exactly one path for each file.
string
required
Vault project identifier.
string ("skip" | "replace" | "keep")
How to handle duplicate file names: skip leaves the existing file, replace creates a replacement record, and keep renames the new file. Omit to use Harvey’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_UPSERT_CLIENTSCreate, update, or restore up to 10,000 Harvey clients by firm client identifier. Always inspect the returned errors array because Harvey can report row-level failures alongside successful rows in HTTP 200 responses. This contract is documentation-derived and has not been live-verified.

Input Parameters

array
required
Clients to create, update, or restore, from 1 to 10,000 rows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HARVEY_UPSERT_MATTERSCreate, update, or restore up to 10,000 Harvey matters under existing clients. Inspect errors even on HTTP 200 because valid rows can succeed while other rows fail. The connected API token needs Harvey’s Client matters admin (write:client_matters) permission; sending allowed on any row additionally needs use:disallowed_client_matters. These are Harvey API-token permissions, not OAuth scopes. This contract and its permissions are documentation-derived and have not been live-verified.

Input Parameters

array
required
Matters to create, update, or restore under existing clients. Harvey processes valid rows even when other rows return errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not