Skip to main content
GET
/
api
/
v1
/
engines
/
{engine_slug}
/
contract
Get Engine Contract
curl --request GET \
  --url https://api.usenexio.com/api/v1/engines/{engine_slug}/contract \
  --header 'Authorization: Bearer <token>'
{
  "markdown": "# Integration Contract: auto-home-pl\n\n## Authentication\nInclude your API key as a Bearer token...\n\n## Endpoints\n- Submit: POST /api/v1/engines/auto-home-pl/runs\n- Poll: GET /api/v1/runs/{runID}\n\n## Scoring Dimensions\n| Key | Label | Method |\n|-----|-------|--------|\n| coverage_completeness | Coverage Completeness | deterministic |\n...",
  "engine_type": "placement",
  "generated_at": "2026-04-05T14:00:00Z"
}

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.

Path Parameters

​
engine_slug
string
required

Engine identifier slug (e.g. default).

Response

Agent integration contract.

​
markdown
string
required

Markdown integration guide generated from the engine's current config. Describes expected request format, scoring dimensions, weight profiles, and example payloads.

​
engine_type
enum<string>
required

Engine type.

Available options:
placement,
entity_analysis
​
generated_at
string<date-time>
required

When the contract was generated.