DataForge Agent API
Ontology Agent API
Query your ontology using natural language. The agent uses AI to understand your questions, execute relevant tools (SQL queries, graph traversal, analytics), and synthesize answers.
Authentication
All endpoints require an API key with appropriate scopes:
agent.read- List tools, view sessions, statsagent.invoke- Execute queries, cancel sessions
Include the API key in the X-API-Key header.
Rate Limits
Rate limits are tier-based:
- Free: 10 requests/minute
- Pro: 50 requests/minute
- Enterprise: 200 requests/minute
Check response headers for current limits:
X-RateLimit-Limit: Max requests per windowX-RateLimit-Remaining: Requests remainingX-RateLimit-Reset: Unix timestamp when limit resets
Authentication
- API Key: apiKey
API key for external integrations. Get yours at Settings > API Keys.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
📄️ Cancel active session
Cancel a running agent session.
📄️ DataForge Agent API
# Ontology Agent API
📄️ Execute action on session
Execute approve, reject, or retry action on a session.
📄️ Execute agent query (synchronous)
Execute a natural language query against your ontology. The agent will:
📄️ Get Hub statistics
Returns statistics about sessions in the Hub.
📄️ Get session execution status
Poll this endpoint to get real-time updates on query execution.
📄️ Get workspace agent statistics
Get usage statistics for the agent in this workspace.
📄️ Invoke agent (polling or SSE mode)
Start an agent query with real-time updates.
📄️ List Hub sessions for workspace
Returns all agent sessions visible in the Hub Kanban dashboard.
📄️ List recent sessions
Get a list of recent agent sessions for this workspace.
📄️ List available agent tools
Get the list of tools the agent can use to answer queries.
📄️ Move session to column
Move a session to a different Kanban column.
📄️ SSE stream for Hub real-time updates
Server-Sent Events stream for real-time Hub dashboard updates.