Sempleo Docs

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:

curl -H "Authorization: Bearer sk_live_your_api_key" \
  https://api.sempleo.ai/api/v1/agents

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 prefixEnvironment
sk_live_Production
sk_test_Sandbox / development

Base URL

https://api.sempleo.ai/api/v1

Response Format

All responses follow this structure:

{
  "data": { ... },
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 142
  }
}

Error responses:

{
  "statusCode": 400,
  "message": "Validation failed",
  "errors": [
    { "field": "email", "message": "must be a valid email" }
  ]
}

Rate Limits

PlanRate Limit
Starter100 req/min
Professional500 req/min
EnterpriseCustom

Rate limit headers are included in every response:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1714680000

Core Resources

Agents

  • GET /agents — List installed agents
  • POST /agents/:id/run — Run an agent with a prompt
  • GET /agents/:id/runs — Get run history

Knowledge

  • GET /knowledge/collections — List knowledge collections
  • POST /knowledge/documents — Upload a document
  • GET /knowledge/search — Search the knowledge base

Integrations

  • GET /integrations/catalog — List available integrations
  • GET /integrations — List connected integrations
  • POST /integrations/connect — Start an integration connection

Workspace

  • GET /workspace/members — List workspace members
  • POST /workspace/members/invite — Invite a new member
  • GET /workspace/teams — List teams

OpenAPI Specification

The full OpenAPI specification is available at:

The specification is auto-generated from the codebase and always reflects the current API.

On this page