Skip to content

Score Desk Email

POST
/desk/email-score

Score a draft 0-100: heuristics for 60%, a model read for 40%.

Never fails for model reasons - with the org’s ai_briefs switch off, or the model unavailable, it returns the heuristic score alone rather than an error. So a 200 here does not prove the AI half ran.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A draft to score 0-100. Heuristics plus an AI read.

object
body
required
string
<= 50000 characters
contact_name
Any of:
string
<= 200 characters
subject
string
"" <= 1000 characters

Responses

200

Successful Response

object
data
required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string