Simply AskingDocs

Building with the Graph API

Access your knowledge graph programmatically to build custom integrations, internal tools, or automated workflows powered by your organization's intelligence layer.

This guide is for admins and developers who want to access the knowledge graph programmatically. You will need basic familiarity with REST APIs and JSON. No specific programming language is required, but examples use standard HTTP requests.

Access your knowledge graph programmatically to build custom integrations, internal tools, or automated workflows powered by your organization's intelligence layer. By the end of this guide, you will have an API key, understand the available endpoints, and know how to make your first API call.

1

Get Your API Key

Navigate to Org Settings and find the API Keys section. Click Generate New Key. Give it a descriptive name (e.g., "Slack Bot", "Dashboard Integration").

Copy and store the key securely. It will not be shown again after you close the dialog. Set permissions: choose read-only for dashboards and reporting, or read-write if your integration needs to create or update data.

2

Understand the Endpoints

Review the available API endpoints. All endpoints return JSON and require your API key in the Authorization header.

EntitiesQuery, filter, and retrieve entity details. Search entities by type (person, organization, concept, topic) or by name.
RelationshipsTraverse connections between entities. Find how two entities are related, or list all relationships for a given entity.
SearchRun the same semantic search available in the UI. Returns ranked documents with relevance scores and entity tags.
DocumentsRetrieve document metadata, content chunks, and associated entities. Filter by department, type, or date.
3

Make Your First API Call

Query entities by type. Request all "person" entities to see who is represented in your knowledge graph.

Search for documents. Pass a query string to the Search endpoint and inspect the JSON response: ranked results with scores, entity tags, and source metadata.

Traverse relationships. Pick an entity from your results and request its relationships to see what it connects to.

4

Build an Integration

Authentication: Include your API key in the Authorization header as a Bearer token with every request.

Rate limits: The API enforces per-key rate limits to ensure fair usage. If you hit a limit, the response includes a Retry-After header.

Error handling: Check for standard HTTP status codes. 400 means invalid parameters, 401 means invalid or expired API key, 403 means insufficient permissions, and 429 means rate limit exceeded.

Rate limitsRequests are limited per key per minute. Monitor your usage and implement exponential backoff for retries.
Error codes400 (bad request), 401 (unauthorized), 403 (forbidden), 429 (rate limited), 500 (server error).

Congratulations! You have completed all 23 workflow guides. You now have the skills to set up, manage, and extend your Simply Asking deployment.

Day 1Organization setup, team invitations, first uploads.
Week 1Search, Ask, knowledge graph exploration, insights.
Weeks 2-4Departments, agents, integrations, content packs, gap closing.
Month 2+Advanced search, private departments, API integrations, optimization.
Was this helpful?