API Reference
Overview of the Sempleo REST API for programmatic access to agents, knowledge, and workspace management.
API access requires the Starter plan or above. Generate API keys in Settings → API Keys.
The Sempleo API is a RESTful JSON API. All endpoints are served from https://api.sempleo.ai/api/v1/.
Authentication
All API requests require a Bearer token:
API Keys
Generate keys in Settings → API Keys. Keys are scoped to your workspace and inherit the permissions of the user who created them.
| Key prefix | Environment |
|---|---|
sk_live_ | Production |
sk_test_ | Sandbox / development |
Base URL
Response Format
All responses follow this structure:
Error responses:
Rate Limits
| Plan | Rate Limit |
|---|---|
| Starter | 100 req/min |
| Professional | 500 req/min |
| Enterprise | Custom |
Rate limit headers are included in every response:
Core Resources
Agents
GET /agents— List installed agentsPOST /agents/:id/run— Run an agent with a promptGET /agents/:id/runs— Get run history
Knowledge
GET /knowledge/collections— List knowledge collectionsPOST /knowledge/documents— Upload a documentGET /knowledge/search— Search the knowledge base
Integrations
GET /integrations/catalog— List available integrationsGET /integrations— List connected integrationsPOST /integrations/connect— Start an integration connection
Workspace
GET /workspace/members— List workspace membersPOST /workspace/members/invite— Invite a new memberGET /workspace/teams— List teams
OpenAPI Specification
The full OpenAPI specification is available at:
- Interactive docs: api.sempleo.ai/api/docs
- JSON spec: api.sempleo.ai/api/openapi.json
The specification is auto-generated from the codebase and always reflects the current API.