Engine Info¶
GET /jobs/about/{tenant_slug}/{engine_slug}
Get metadata about an engine including the active version number, input/output schemas, and description. Use this to discover what inputs an engine expects before calling execute.
Required permission: can_view_about
Path Parameters¶
| Parameter | Type | Description |
|---|---|---|
tenant_slug |
string | Tenant identifier |
engine_slug |
string | Engine identifier |
Response¶
200 OK
{
"name": "Property Calculator",
"slug": "property-calculator",
"description": "Calculate property insurance premiums",
"version": "2.1",
"input_schema": {
"type": "object",
"properties": {
"customerAge": {
"type": "integer",
"minimum": 18,
"maximum": 100
},
"propertyValue": {
"type": "number",
"minimum": 0
}
},
"required": ["customerAge", "propertyValue"]
},
"output_schema": {
"type": "object",
"properties": {
"premium": { "type": "number" },
"deductible": { "type": "number" }
}
},
"updated_at": "2026-03-10T14:30:00Z"
}
| Field | Type | Description |
|---|---|---|
name |
string | Human-readable engine name |
slug |
string | URL-safe engine identifier |
description |
string or null | Engine description |
version |
string | Currently active version number |
input_schema |
object or null | JSON Schema (Draft 7) for input validation |
output_schema |
object or null | JSON Schema describing the output structure |
updated_at |
datetime | When the active version was last updated |
Schemas¶
Both input_schema and output_schema follow JSON Schema Draft 7.
The input schema is enforced server-side — if your inputs don't match, the execute endpoint returns 400. You can use the same schema for client-side validation.
The output schema is informational — it describes the shape of the outputs you'll receive but is not enforced.
Schema may be null
If the tenant administrator hasn't defined schemas for a version, both fields will be null. In this case, the engine accepts any input object and the output structure depends on the Excel file's named ranges.
Errors¶
400 Bad Request — engine has no active version
403 Forbidden — no about permission or IP not whitelisted
404 Not Found — tenant or engine not found