Guidelines
A guideline is a rule written in plain language. Infrared reads it together with the project context, scores every submission of a template that enables it, and returns the score as the policy guideline/<slug>.
Endpoints
- GET/v1/guidelinesList guidelines
- POST/v1/guidelinesCreate a guideline
- GET/v1/guidelines/{id}Retrieve a guideline
- PATCH/v1/guidelines/{id}Update a guideline
- DELETE/v1/guidelines/{id}Delete a guideline
The guideline object
A rule in plain language, scored by a model as its own policy.
{
"object": "guideline",
"id": "gl_4R8CeEbylEzY7fCtrNNQPR",
"project_id": "prj_0TBAgHGtdMketrbltGFHuk",
"slug": "no-off-site-deals",
"policy": "guideline/no-off-site-deals",
"title": "No off-site deals",
"instructions": "Sellers must not ask buyers to pay or to arrange the deal outside the platform: bank transfers, payment links, crypto, or a move to email, phone or a messaging app. Flag any attempt.",
"examples": {
"compliant": [
"Collection in person or tracked delivery, payment through the site."
],
"violating": [
"Pay me by bank transfer and I will knock 10% off.",
"Message me on my number, it is easier than the chat here."
]
},
"enabled": true,
"position": 0,
"created_at": "2026-10-08T08:44:27.742Z",
"updated_at": "2026-10-08T08:44:27.742Z"
}Attributes
object"guideline"Always
guideline.idstringId of the guideline:
gl_plus 22 base62 characters.slugstringThe slug in the policy key. Set when the guideline is created and never changed.
policystringThe policy key under which the guideline is scored and returned:
guideline/<slug>.titlestringA short name for the rule.
instructionsstringThe rule in plain language, up to 4,000 characters.
examplesobjectSample texts that sharpen the rule.
violatingarray of stringsTexts that break the rule, up to 20.
compliantarray of stringsTexts that follow the rule, up to 20.
enabledbooleanWhether the guideline is evaluated. A disabled guideline scores 0 on the templates that enable it.
project_idstringId of the project:
prj_plus 22 base62 characters.positionintegerPlace of the guideline in the list and in the prompt, an integer from 0.
created_attimestampWhen the guideline was created, ISO 8601 in UTC.
updated_attimestampWhen the guideline last changed, ISO 8601 in UTC.
Something missing or unclear on this page? Write to support@useinfrared.com.