Developer Platform
Developer Platform
Akurion gives developers a governed knowledge API over project data. Use it to build assistants, internal tools, retrieval workflows, and MCP-compatible agents.
Developer Surfaces
| Surface | Use when |
|---|---|
| REST API | You want conventional HTTP endpoints for search, answers, files, data sources, and discovery. |
| MCP JSON-RPC | You are integrating with an agent or MCP-compatible tool caller. |
| API explorer | You want to test endpoints from the UI. |
| MCP playground | You want to inspect tool schemas and run MCP calls interactively. |
| UI proxies | You are using authenticated in-app calls rather than external API keys. |
Authentication Model
Akurion supports:
- Project API keys for one project.
- Subscription API keys for all or selected projects.
- Project context through
X-Project-ID, body fields, query parameters, or MCP arguments. - Rate limits and credit tracking.
- Hashed-at-rest API key runtime validation.
Quick REST Example
curl -X POST "https://api.structhub.io/api/v1/search/vector" \ -H "Content-Type: application/json" \ -H "API-KEY: YOUR_API_KEY" \ -H "X-Project-ID: YOUR_PROJECT_ID" \ -d '{ "query": "incident response escalation policy", "top_k": 20 }'Quick MCP Example
curl -X POST "https://api.structhub.io/mcp-server" \ -H "Content-Type: application/json" \ -H "API-KEY: YOUR_API_KEY" \ -H "X-Project-ID: YOUR_PROJECT_ID" \ -d '{ "jsonrpc": "2.0", "method": "tools/call", "params": { "name": "vector_search", "arguments": { "query": "incident response escalation policy", "top_k": 20 } }, "id": 1 }'Recommended Integration Pattern
- Use
list_accessible_projectsto discover project scope. - Use
get_project_settingsandlist_project_metadata_keysto understand retrieval defaults. - Use
discover_metadata_schemaorlist_metadata_valuesto build filters. - Use
vector_searchorvector_search_with_metadata_filterfor evidence retrieval. - Use
answer_queryfor final cited synthesis. - Use
get_file_by_id,get_file_chunks, and file access APIs for source drill-down.
Safety Guidelines
- Store API keys in a secrets manager.
- Use project-scoped keys when possible.
- Use selected-project subscription keys for multi-project integrations.
- Do not log raw API keys, OAuth codes, full sensitive payloads, or source documents.
- Use metadata filters to keep retrieval narrow.
- Monitor credits and rate limits.
- Revoke keys that are no longer needed.