Create prio model
POST /prio-models. Parameters, permissions, request and response schemas.
POST /prio-models
Create prio model. Requires the REST write token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation. A Team in blocked billing mode cannot write and receives 402.
Authentication
Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.
{
"ability": "write",
"team": "Token-bound Team",
"authorization": "Additional role, entity-policy and plan requirements vary by operation.",
"billing": "Blocked billing mode rejects writes with 402."
}Request body
A request body is required.
application/json
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
]
},
"default_config": {
"type": "object",
"properties": {
"formula": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"key": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"enum": [
"number",
"boolean",
"select"
]
},
"options": {
"type": [
"array",
"null"
],
"items": {
"description": "An arbitrary JSON value retained by a metadata/settings field.",
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
}
}
]
},
"description": "Question options retained as JSON. The editor uses strings or objects with value and label.",
"example": [
"Delivery time",
"Shipping cost"
]
},
"default": {
"type": [
"string",
"null"
]
},
"min": {
"type": [
"number",
"null"
]
},
"max": {
"type": [
"number",
"null"
]
},
"step": {
"type": [
"number",
"null"
]
},
"weight": {
"type": [
"number",
"null"
]
}
},
"required": [
"name",
"key",
"type"
]
},
"minItems": 1
}
},
"required": [
"formula",
"inputs"
]
}
},
"required": [
"name",
"default_config"
],
"title": "StorePrioModelRequest",
"example": {
"name": "ICE",
"default_config": {
"formula": "impact * confidence / effort",
"inputs": [
{
"name": "Impact",
"key": "impact",
"type": "number",
"min": 1,
"max": 10,
"weight": 1
},
{
"name": "Confidence",
"key": "confidence",
"type": "number",
"min": 1,
"max": 10,
"weight": 1
},
{
"name": "Effort",
"key": "effort",
"type": "number",
"min": 1,
"max": 10,
"weight": 1
}
]
}
}
}{
"name": "ICE",
"default_config": {
"formula": "impact * confidence / effort",
"inputs": [
{
"name": "Impact",
"key": "impact",
"type": "number",
"min": 1,
"max": 10,
"weight": 1
},
{
"name": "Confidence",
"key": "confidence",
"type": "number",
"min": 1,
"max": 10,
"weight": 1
},
{
"name": "Effort",
"key": "effort",
"type": "number",
"min": 1,
"max": 10,
"weight": 1
}
]
}
}Example request
curl --request POST 'https://api.example.test/api/prio-models' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"name":"ICE","default_config":{"formula":"impact * confidence / effort","inputs":[{"name":"Impact","key":"impact","type":"number","min":1,"max":10,"weight":1},{"name":"Confidence","key":"confidence","type":"number","min":1,"max":10,"weight":1},{"name":"Effort","key":"effort","type":"number","min":1,"max":10,"weight":1}]}}'Examples use fictional data. Replace resource IDs and the API host with your environment’s values.
Responses
201
PrioModelResource
Content type: application/json.
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"default_config": {
"type": "object",
"properties": {
"formula": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"key": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"enum": [
"number",
"boolean",
"select"
]
},
"options": {
"type": [
"array",
"null"
],
"items": {
"description": "An arbitrary JSON value retained by a metadata/settings field.",
"oneOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
}
}
]
},
"description": "Question options retained as JSON. The editor uses strings or objects with value and label.",
"example": [
"Delivery time",
"Shipping cost"
]
},
"default": {
"type": [
"string",
"null"
]
},
"min": {
"type": [
"number",
"null"
]
},
"max": {
"type": [
"number",
"null"
]
},
"step": {
"type": [
"number",
"null"
]
},
"weight": {
"type": [
"number",
"null"
]
}
},
"required": [
"name",
"key",
"type"
]
},
"minItems": 1
}
},
"required": [
"formula",
"inputs"
]
},
"created_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"updated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"id",
"name",
"description",
"default_config",
"created_at",
"updated_at"
],
"title": "PrioModelResource"
}
},
"required": [
"data"
]
}{
"data": {
"id": 101,
"name": "Checkout delivery estimate",
"description": null,
"default_config": {
"formula": "impact * confidence / effort",
"inputs": [
{
"name": "Checkout delivery estimate",
"key": "example",
"description": null,
"type": "number"
}
]
},
"created_at": null,
"updated_at": null
}
}401
Unauthenticated
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}{
"message": "The request could not be completed."
}402
The Team is in read-only billing mode.
Content type: application/json.
{
"type": "object",
"properties": {
"error": {
"type": "string",
"const": "subscription_required"
},
"mode": {
"type": "string",
"const": "blocked"
},
"message": {
"type": "string",
"example": "Your team is in read-only mode. Update billing to make changes."
},
"grace_period_ends_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"error",
"mode",
"message",
"grace_period_ends_at"
]
}{
"error": "subscription_required",
"mode": "blocked",
"message": "Your team is in read-only mode. Update billing to make changes.",
"grace_period_ends_at": null
}403
Authorization error
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}{
"message": "The request could not be completed."
}422
Validation error
Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}{
"message": "The request could not be completed.",
"errors": {
"name": [
"The name field is required."
]
}
}429
Rate limit exceeded. Honor Retry-After before retrying.
Response headers:
{
"Retry-After": {
"description": "Seconds before retrying.",
"schema": {
"type": "integer"
}
}
}Content type: application/json.
{
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Too Many Attempts."
}
},
"required": [
"message"
]
}{
"message": "Too Many Attempts."
}See API conventions for error handling, rate limits, pagination, and uploads.