POST
https://api.nexscope.ai/jev/routeRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/jev/route |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
intent | string | required | One routing intent. It is used only for discovery and is never converted into API or evaluation input. Example: Fetch Amazon product reviews by ASIN so I can analyze customer pain points |
categorySlug | string | optional | Optional current public catalog category, or jev-evaluation to limit discovery to the fixed presets. Example: amazon-marketplace-intelligence |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"data": {
"candidates": [],
"catalogVersion": "<catalog version>",
"confidence": 0.91,
"match": {
"docsPath": "/api-docs/amazon-reviews-list?view=api",
"endpoint": "/api/skill-api/v1/skills/amazon-reviews-list/run",
"kind": "skill_api",
"mcpToolName": "nexscope_amazon_reviews_list",
"method": "POST",
"name": "Amazon Reviews List",
"schemaEndpoint": "/api/skill-api/v1/skills/amazon-reviews-list",
"slug": "amazon-reviews-list"
},
"models": [
"<resolved model>"
],
"policyVersion": "jev-routing-v2",
"reason": "matched",
"status": "matched"
},
"msg": "success"
}Response fields
Nexscope response envelope. The router returns trusted metadata and never executes the matched API or evaluation preset.
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | Zero on success; non-zero for validation, access, quota, or availability errors. |
data | object | required | For matched, call the returned endpoint separately after collecting its required fields. For ambiguous, ask the user to clarify and route again. For no_match, do not invent or execute a capability. |
data.candidates | array | required | Up to three clarification candidates for an ambiguous result. |
data.candidates[] | object | required | Item in data candidates. |
data.catalogVersion | string | required | Catalog timestamp used for this routing decision. |
data.confidence | number | null | required | Confidence value used by this API operation. Minimum: 0 Maximum: 1 |
data.match | any | required | Match value used by this API operation. |
data.models | array | required | Resolved model versions used by the routing stages. |
data.models[] | string | required | Item in data models. |
data.policyVersion | string | required | Server-owned routing policy version. |
data.reason | string | required | Reason value used by this API operation. Allowed: matched, clarification_required, no_supported_api |
data.status | string | required | Status value used by this API operation. Allowed: matched, ambiguous, no_match |
msg | string | required | Response message. |
Published data API match
| Name | Type | Required | Description |
|---|---|---|---|
data.match | object | required | Match value used by this API operation. |
data.match.docsPath | string | required | Docs path value used by this API operation. |
data.match.endpoint | string | required | Endpoint value used by this API operation. |
data.match.kind | string | required | Kind value used by this API operation. Constant: skill_api |
data.match.mcpToolName | string | required | Mcp tool name value used by this API operation. |
data.match.method | string | required | Method value used by this API operation. Constant: POST |
data.match.name | string | required | Name value used by this API operation. |
data.match.schemaEndpoint | string | required | Schema endpoint value used by this API operation. |
data.match.slug | string | required | Slug value used by this API operation. |
Fixed JEV use-case match
| Name | Type | Required | Description |
|---|---|---|---|
data.match | object | required | Match value used by this API operation. |
data.match.docsPath | string | required | Docs path value used by this API operation. |
data.match.endpoint | string | required | Endpoint value used by this API operation. |
data.match.kind | string | required | Kind value used by this API operation. Constant: jev_use_case |
data.match.mcpToolName | string | required | Mcp tool name value used by this API operation. |
data.match.method | string | required | Method value used by this API operation. Constant: POST |
data.match.name | string | required | Name value used by this API operation. |
data.match.schemaEndpoint | string | required | Schema endpoint value used by this API operation. |
data.match.schemaPointer | string | required | Schema pointer value used by this API operation. |
data.match.useCase | string | required | Use case value used by this API operation. |
One of option 3
| Name | Type | Required | Description |
|---|---|---|---|
data.match | null | required | Null for ambiguous and no_match responses. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.