Skip to main content
POST
/
api
/
v1
/
engines
Create Engine
curl --request POST \
  --url https://api.usenexio.com/api/v1/engines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "my-engine",
  "label": "Product Comparison Engine",
  "description": "Rank offerings from multiple providers.",
  "engine_type": "placement"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "slug": "my-engine",
  "label": "Product Comparison Engine",
  "description": "Rank offerings from multiple providers.",
  "engine_type": "placement",
  "status": "active",
  "created_at": "2026-04-01T10:00:00Z",
  "updated_at": "2026-04-01T10:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.usenexio.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key with environment prefix. Use nx_test_... for sandbox and nx_live_... for production. Obtain keys at platform.usenexio.com/settings/api-keys.

Body

application/json
​
slug
string
required

URL-safe identifier. 3–50 lowercase alphanumeric characters and hyphens. Must start and end with an alphanumeric character.

Required string length: 3 - 50
Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
​
label
string
required

Human-readable engine name.

Required string length: 1 - 100
​
engine_type
enum<string>
required

Engine type determines the config schema and pipeline behavior.

Available options:
placement,
entity_analysis
​
description
string

Optional engine description.

Maximum string length: 500

Response

Engine created with default configuration.

Engine metadata returned by management endpoints.

​
id
string
required

Engine identifier.

​
slug
string
required

URL-safe engine slug, unique within the organization.

​
label
string
required

Human-readable engine name.

​
description
string
required

Optional engine description.

​
engine_type
enum<string>
required

Engine type. placement engines rank provider offerings into optimal solutions. entity_analysis engines evaluate current state against requirements and find gaps.

Available options:
placement,
entity_analysis
​
status
enum<string>
required

Engine status. Archived engines cannot have their config updated.

Available options:
active,
archived
​
created_at
string<date-time>
required

RFC 3339 creation timestamp.

​
updated_at
string<date-time>
required

RFC 3339 last-update timestamp.