Skip to main content
POST
Create Request

Permissions

Requires Intake permissions. If these permissions are not available to select, contact support@harvey.ai.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
idempotency_key
string
required

An identifier you choose for this request, unique within your workspace. A retry carrying a key Harvey has already accepted returns the original request with 200 instead of creating a second one. Must not be blank or whitespace only.

Minimum string length: 1
Example:

"ticket-48213"

title
string
required

Short summary of what is being asked for. Surrounding whitespace is stripped, and the result must not be empty.

Required string length: 1 - 255
Example:

"Review the Northwind master services agreement"

description
string

The full request, in as much detail as the reviewer needs.

Maximum string length: 10000
Example:

"Counterparty sent back redlines on the termination and liability sections. Please review against our standard positions and flag anything that needs partner sign-off."

files
file[]

A document the request concerns. Repeat the field once per document. Up to 50 files, and up to 100 MB per file for most types. A file whose type or size is not accepted refuses the entire request, so a request never silently loses a document.

Response

A request with this idempotency_key was already accepted. The body names the original request, and nothing new was created.

Returned when a request is submitted, and when a retry replays an idempotency key Harvey already accepted.

request_id
string<uuid>

The unique identifier of the intake request. Store it to read the request later.

status
enum<string>

The request's status. Always RECEIVED on submission, confirming Harvey has taken the request. Read the request to see the lifecycle status it is working through.

Available options:
RECEIVED
harvey_url
string

Deep link to the request in Harvey, for handing it to a person.