Skip to content

Create an inference rule

POST
/api/v1/inference-rules
curl --request POST \
--url https://api.aletheia-ops.com/api/v1/inference-rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "kind": "example", "match": {}, "action": {}, "priority": 1, "enabled": true }'
Media typeapplication/json

Creates a user-authored inference rule

object
kind
required
string
match
required
object
key
additional properties
any
action
object
key
additional properties
any
priority
integer
enabled
boolean
Examplegenerated
{
"kind": "example",
"match": {},
"action": {},
"priority": 1,
"enabled": true
}

Created

Media typeapplication/json

Public shape of a tag-based inference rule

object
id
string
organization_id
string
kind
string
match
object
key
additional properties
any
action
object
key
additional properties
any
priority
integer
enabled
boolean
origin
string
created_by
string
created_at
string format: date-time
Examplegenerated
{
"id": "example",
"organization_id": "example",
"kind": "example",
"match": {},
"action": {},
"priority": 1,
"enabled": true,
"origin": "example",
"created_by": "example",
"created_at": "2026-04-15T12:00:00Z"
}

The request is malformed or fails validation.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "validation_failed",
"message": "name: must not be blank"
}

No valid credential was presented, or it has expired.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "unauthorized",
"message": "authentication required"
}

Authenticated, but not permitted to perform this action.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "forbidden",
"message": "you do not have permission to perform this action"
}

The request conflicts with the current state.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
{
"code": "email_taken",
"message": "an account with this email already exists"
}

An unexpected failure. Diagnostic detail is logged server-side and deliberately not returned. Quote the X-Request-Id response header when reporting one.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
Exampleinternal_error
{
"code": "internal_error",
"message": "internal server error"
}