SolutionEngine LogoSolutionEngine
HomeProductUse CasesPricing

API Reference

This section documents the main backend API surfaces used by the platform and frontend.

The reference is organized by domain so teams can quickly find the relevant endpoint families.

Routes are sourced from backend service modules under Core/api*.py in this repository.

API Domains

  • Authentication
  • Projects and Workflows
  • Datasources and Buckets
  • Environments
  • Models and Training
  • Logs and Monitoring
  • Agents and Agent Tools

Base Conventions

  • Base path: /api
  • Content type: application/json unless noted otherwise
  • Auth: bearer/session based on deployment mode
  • IDs: project_id, workflow_id, datasource_id, bucket_id, env_id

Response and Error Model

Typical success response:

{
	"ok": true,
	"data": {}
}

Typical error response:

{
	"ok": false,
	"error": {
		"code": "VALIDATION_ERROR",
		"message": "Missing required field: name"
	}
}

Common status patterns:

  • 200 read/update success
  • 201 resource created
  • 400 request validation failed
  • 401 unauthorized
  • 403 forbidden
  • 404 resource not found
  • 409 conflict (duplicate or invalid state transition)
  • 500 internal server error

Quick Endpoint Index

Recommended Reading

  1. API Authentication
  2. API Projects and Workflows
  3. API Datasources and Buckets
  4. API Environments
  5. API Models and Training
  6. API Logs and Monitoring
  7. API Agents and Agent Tools
  8. API Endpoint Index

Related Pages

PreviousStorage Buckets
NextDatasource - HTTP GET