API Référence
Documentation complete de l'API REST et GraphQL pour l'écosystème HarchOS.
Authentification
Authentifiez-vous avec des jetons Bearer dans l'en-tête Authorization. Les jetons sont obtenus via le point de terminaison /auth/token.
X-API-Key: hrch_live_sk_abc123def456Requis pour toutes les requêtes API 0 Use Case
Authentifiez-vous avec des clés API transmises via l'en-tête X-API-Key. Adapté à la communication serveur à serveur.
Authorization: Bearer eyJhbGciOiJSUzI1NiIs...Requis pour toutes les requêtes API 1 Use Case
Authentifiez-vous avec OAuth 2.0 via le flux d'informations d'identification du client. Prend en charge l'accès à portée limitée et le rafraîchissement des jetons.
Authorization: Bearer <jwt_token>Requis pour toutes les requêtes API 2 Use Case
REST
Documentation complète des API REST et GraphQL pour l'écosystème HarchOS.
/v1/compute/workloads/v1/compute/workloads/v1/compute/workloads/:id/v1/compute/workloads/:id/v1/compute/workloads/:id/v1/compute/workloads/:id/scale/v1/compute/workloads/:id/migrate/v1/carbon/intensity/v1/carbon/optimal-hub/v1/carbon/optimize/v1/carbon/forecast/v1/carbon/metrics/v1/carbon/dashboard/v1/data/pipelines/v1/data/pipelines/v1/data/pipelines/:id/ingest/v1/data/lakes/v1/data/lakes/:id/snapshot/v1/models/v1/models/v1/models/:id/deploy/v1/models/:id/train/v1/models/:id/metrics/v1/inference/v1/pricing/plans/v1/pricing/plans/:id/v1/pricing/estimate/v1/pricing/billing/records/v1/pricing/billing/records/:id/v1/regions/v1/regions/:code/v1/operations/hubs/v1/operations/hubs/:id/v1/operations/failover/v1/operations/energy/v1/operations/schedule/v1/monitoring/metrics/v1/monitoring/health/detailed/v1/monitoring/alerts/v1/monitoring/alerts/rules/v1/monitoring/traces/v1/monitoring/logsgRPC
Documentation complète des API REST et GraphQL pour l'écosystème HarchOS.
ComputeService — Allocation GPU et ordonnancement des charges de travail
CreateWorkloadGetWorkloadListWorkloadsScaleWorkloadMigrateWorkloadStreamWorkloadEventsDataService — Ingestion, stockage et récupération de données
CreatePipelineIngestDataGetSnapshotStreamDataModelService — Entraînement et inférence de modèles IA
RegisterModelDeployModelTrainModelStreamInferenceMonitorService — Surveillance d'infrastructure en temps réel
GetHubStatusStreamMetricsInitiateFailoverGetEnergyReportAuthService — Authentification et autorisation
AuthenticateAuthorizeStreamAuditEventsRevokeTokenWebSocket
Documentation complète des API REST et GraphQL pour l'écosystème HarchOS.
/v1/ws/workloads/:id/eventsws://api.harchos.ai/v1/stream/metrics — Real-time infrastructure metricsJSON over WebSocket/v1/ws/metrics/streamws://api.harchos.ai/v1/stream/events — Live event streamJSON over WebSocket/v1/ws/models/:id/inferencews://api.harchos.ai/v1/stream/logs — Real-time log streamingJSON over WebSocket/v1/ws/audit/eventsws://api.harchos.ai/v1/stream/notifications — Push notificationsJSON over WebSocket/v1/ws/hubs/:id/telemetryws://api.harchos.ai/v1/stream/alerts — Real-time alertsProtobuf over WebSocketLimites de débit
Documentation complète des API REST et GraphQL pour l'écosystème HarchOS.
| Niveau | Demandes | Rafale | Calcul | Données |
|---|---|---|---|---|
| Gratuit | 100 req/min | 50 req | 10 GPU-hrs/mois | 5 GB/month |
| Professionnel | 1,000 req/min | 500 req | 500 GPU-hrs/mois | 50 GB/month |
| Entreprise | 10,000 req/min | 5,000 req | Illimité | 500 GB/month |
| Souverain | Personnalisé | Personnalisé | Personnalisé | Personnalisé |
| Classifié | Dédié | Dédié | Dédié | Dédié |
Gestion des erreurs
La requête était malformée ou des paramètres requis étaient manquants.
L'authentification a échoué ou n'a pas été fournie.
L'utilisateur authentifié n'a pas la permission d'accéder à cette ressource.
La ressource demandée n'existe pas.
Limite de débit dépassée. Réessayez après la durée spécifiée.
Une erreur inattendue s'est produite sur le serveur.
Le serveur a reçu une réponse invalide d'un service en amont.
Le serveur est temporairement indisponible. Veuillez réessayer plus tard.
Exemples de code
curl -X POST https://api.harchos.ai/v1/compute/workloads \
-H "Authorization: Bearer hrch_live_sk_abc123" \
-H "Content-Type: application/json" \
-d '{
"name": "llama-inference-prod",
"gpu": "H100",
"count": 8,
"region": "morocco-dakhla",
"sovereignty": "strict",
"carbonAware": true,
"schedule": "carbon-optimal"
}'