Skip to content

Knowledge

Base URL: https://app.trymaglev.com/api/v1. All endpoint families.

Full text search over explicitly published document revisions. Sandbox keys see published playbooks only. Internal categories and paths do not grant access; an empty published corpus returns no hits.

Required scope: knowledge:read.

Authentication: bearer key.

Parameter Location Required Details
q query Yes
kind query No playbook, research, spec or legal
200 response schema
{
"type": "object",
"properties": {
"hits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"title": {
"type": "string"
},
"kind": {
"type": "string"
},
"headline": {
"type": "string"
},
"fileModifiedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
},
"count": {
"type": "integer"
}
}
}

Errors: 400 Validation error; 401 Missing or invalid key; 403 Scope or mode does not allow this; 404 Not found; 429 Rate limit reached. See recovery guidance.

One explicitly published document revision by exact repo path (production keys). Unpublished, changed and missing revisions return 404.

Required scope: knowledge:read.

Authentication: bearer key.

Parameter Location Required Details
path query Yes Exact path returned by knowledge/search for a currently published revision
200 response schema
{
"type": "object",
"properties": {
"path": {
"type": "string"
},
"title": {
"type": "string"
},
"kind": {
"type": "string"
},
"content": {
"type": "string"
}
}
}

Errors: 400 Validation error; 401 Missing or invalid key; 403 Scope or mode does not allow this; 404 Not found; 429 Rate limit reached. See recovery guidance.

Error