Skip to content
Documentation

Create AI Review

POST
/api/v1/workspaces/{workspace_id}/emails/{id}/ai_reviews

Creates a new AI review request for an email.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

id
required
integer

Email ID

Request Body

Section titled “Request Body ”
object
ai_reviewer_id
required
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
id
required
integer
Example
12345
email_id
required
integer
Example
12345
ai_reviewer_id
required
integer
Example
67890
requested_by_id
required
integer
Example
12345
status
required
string
Allowed values: in_progress completed failed
created_at
required
string format: date-time
Example
2026-03-20T10:30:00.000Z
ended_at
required
string format: date-time
nullable
Example
2026-03-20T10:32:00.000Z
ai_reviewer
required
object
id
required
integer
Example
67890
name
required
string
Example
Spellcheck Bot

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

object
message
required
string
Example
Failed to save
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}