POST
nicola_ask
/askAPIs
URSY.FM NICOLA
Contract
- Version
- 1.0.0
- Base URL
https://ursy.fm/wp-json/nicola/v2- Published source
- OpenAPI ↗
Endpoints are extracted from this version. Original snapshots are retained when a source changes.
Authentication
Requirements are recorded per operation. An API can contain both public and protected endpoints.
Read the authentication guide →Endpoints
GET
nicola_capabilities
/capabilitiesGET
nicola_hello
/helloGET
nicola_manifest
/manifestGET
nicola_status
/statusInspect the accepted OpenAPI document
{
"openapi": "3.1.0",
"info": {
"title": "URSY.FM NICOLA",
"version": "1.0.0"
},
"servers": [
{
"url": "https://ursy.fm/wp-json/nicola/v2"
}
],
"paths": {
"/hello": {
"get": {
"operationId": "nicola_hello",
"responses": {
"200": {
"description": "Approved public source data",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/manifest": {
"get": {
"operationId": "nicola_manifest",
"responses": {
"200": {
"description": "Approved public source data",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"503": {
"description": "No unexpired worker-materialized manifest."
}
}
}
},
"/capabilities": {
"get": {
"operationId": "nicola_capabilities",
"responses": {
"200": {
"description": "Approved public source data",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"409": {
"description": "Capability generation changed; restart without a cursor."
}
},
"parameters": [
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string",
"pattern": "^(0|v1\\.[a-f0-9]{24}\\.[0-9]{1,4})$"
}
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}
}
]
}
},
"/status": {
"get": {
"operationId": "nicola_status",
"responses": {
"200": {
"description": "Approved public source data",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
},
"/ask": {
"post": {
"operationId": "nicola_ask",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 4000
},
"constraints": {
"type": "object"
},
"conversation_ref": {
"type": "string",
"maxLength": 2048
},
"max_results": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 5
}
},
"additionalProperties": false,
"required": [
"question"
]
}
}
}
},
"responses": {
"200": {
"description": "Bounded local answer",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"request_id",
"status",
"intent",
"answer",
"items",
"sources",
"freshness",
"clarification",
"next_actions"
],
"properties": {
"request_id": {
"type": "string"
},
"status": {
"enum": [
"answered",
"needs_clarification",
"out_of_scope",
"unavailable",
"pending"
]
},
"intent": {
"type": "string"
},
"answer": {
"type": "string"
},
"items": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object"
}
},
"sources": {
"type": "array"
},
"freshness": {
"type": "object"
},
"clarification": {
"type": [
"string",
"null"
]
},
"next_actions": {
"type": "array"
},
"conversation_ref": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"400": {
"description": "Invalid question or constraints"
},
"429": {
"description": "Rate limited"
}
}
}
}
},
"components": {
"schemas": [],
"securitySchemes": []
}
}