Create AI review agent

POST

/api/v1/workspaces/{workspace_id}/ai_reviewers

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/ai_reviewers';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","review_instructions":"Check for spelling errors, broken links, and brand guideline compliance."}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/ai_reviewers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "review_instructions": "Check for spelling errors, broken links, and brand guideline compliance." }'

Creates a new AI review agent.

Authorizations

OAuth2
agents:write

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

Request Body

application/json

object

name

required

string

review_instructions

required

Instructions the AI review agent should follow when reviewing emails.

string

Example

Check for spelling errors, broken links, and brand guideline compliance.

Responses

201

Successful

application/json

object

required

integer

name

required

string

review_instructions

required

string

Example

{
  "id": 12345,
  "name": "My AI Agent",
  "review_instructions": "My AI Agent is a helpful assistant that can help with tasks."
}

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

422

Unprocessable Entity

application/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."
    ]
  }
}