oib/aitbc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
aitbc/docs/developer/api/coordinator/openapi.md
oib ff5486fe08 ``` 
chore: refactor logging module, update genesis timestamp, remove model relationships, and reorganize routers

- Rename logging.py to logger.py and update import paths in poa.py and main.py
- Update devnet genesis timestamp to 1766828620
- Remove SQLModel Relationship declarations from Block, Transaction, and Receipt models
- Add SessionDep type alias and get_session dependency in coordinator-api deps
- Reorganize coordinator-api routers: replace explorer/registry with exchange, users, marketplace
2025-12-28 21:05:53 +01:00

2.1 KiB
Raw Blame History

title, description
title description
OpenAPI Specification Complete OpenAPI specification for the Coordinator API

OpenAPI Specification

The complete OpenAPI 3.0 specification for the AITBC Coordinator API is available below.

Interactive Documentation

  • Swagger UI - Interactive API explorer
  • ReDoc - Alternative documentation view

Download Specification

Key Endpoints

Jobs

  • POST /v1/jobs - Create a new job
  • GET /v1/jobs/{job_id} - Get job details
  • GET /v1/jobs - List jobs
  • DELETE /v1/jobs/{job_id} - Cancel job
  • GET /v1/jobs/{job_id}/results - Get job results

Marketplace

  • POST /v1/marketplace/offers - Create offer
  • GET /v1/marketplace/offers - List offers
  • POST /v1/marketplace/offers/{offer_id}/accept - Accept offer

Receipts

  • GET /v1/receipts/{job_id} - Get receipt
  • POST /v1/receipts/verify - Verify receipt

Analytics

  • GET /v1/marketplace/stats - Get marketplace statistics
  • GET /v1/miners/{miner_id}/stats - Get miner statistics

Authentication

All endpoints require authentication via the X-API-Key header.

Rate Limits

API requests are rate-limited based on your subscription plan.

WebSocket API

Real-time updates available at:

  • WebSocket: wss://aitbc.bubuit.net/ws
  • Message types: job_update, marketplace_update, receipt_created

Code Generation

Use the OpenAPI spec to generate client libraries:

# OpenAPI Generator
openapi-generator-cli generate -i openapi.json -g python -o ./client/

# Or use the online generator at https://openapi-generator.tech/

SDK Integration

The OpenAPI spec is integrated into our official SDKs:

Support

For API support: