Skip to content
Documentation

Create AI Review

POST
/api/v1/workspaces/{workspace_id}/emails/{id}/ai_reviews
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/emails/1/ai_reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ai_reviewer_id": 1 }'

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”
Media typeapplication/json
object
ai_reviewer_id
required
integer
Examplegenerated
{
  "ai_reviewer_id": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful

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

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

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