Files
aitbc/docs/apps/clients/6_api-reference.md
aitbc 19d415a235
Some checks failed
Blockchain Synchronization Verification / sync-verification (push) Failing after 3s
CLI Tests / test-cli (push) Failing after 3s
Cross-Chain Functionality Tests / test-cross-chain-sync (push) Successful in 2s
Cross-Chain Functionality Tests / test-cross-chain-transactions (push) Successful in 3s
Cross-Chain Functionality Tests / test-cross-chain-bridge (push) Has been skipped
Cross-Chain Functionality Tests / test-multi-chain-consensus (push) Successful in 2s
Cross-Chain Functionality Tests / aggregate-results (push) Has been skipped
Deploy to Testnet / deploy-testnet (push) Successful in 1m12s
Documentation Validation / validate-docs (push) Failing after 8s
Documentation Validation / validate-policies-strict (push) Successful in 3s
Integration Tests / test-service-integration (push) Successful in 2m6s
Multi-Chain Island Architecture Tests / test-multi-chain-island (push) Successful in 2s
Multi-Node Blockchain Health Monitoring / health-check (push) Failing after 4s
P2P Network Verification / p2p-verification (push) Successful in 4s
Package Tests / Python package - aitbc-agent-sdk (push) Successful in 32s
Package Tests / Python package - aitbc-core (push) Successful in 14s
Package Tests / Python package - aitbc-crypto (push) Successful in 12s
Package Tests / Python package - aitbc-sdk (push) Successful in 9s
Package Tests / JavaScript package - aitbc-sdk-js (push) Successful in 8s
Package Tests / JavaScript package - aitbc-token (push) Successful in 17s
Python Tests / test-python (push) Successful in 15s
Security Scanning / security-scan (push) Successful in 27s
Node Failover Simulation / failover-test (push) Successful in 7s
Multi-Node Stress Testing / stress-test (push) Successful in 6s
Cross-Node Transaction Testing / transaction-test (push) Successful in 4s
feat: add SQLCipher database encryption support and consolidate agent documentation
- Add SQLCipher encryption for ait-mainnet database with configurable flag
- Add db_encryption_enabled and db_encryption_key_path config settings
- Implement encryption key loading and PRAGMA key setup via connection events
- Add shutdown_db function for proper database cleanup
- Export middleware classes in aitbc/__init__.py
- Fix import path in sync.py for settings
- Remove duplicate agent documentation from docs
2026-05-03 12:00:38 +02:00

1.7 KiB

Client API Reference

REST API endpoints for client operations.

Endpoints

Submit Job

POST /v1/jobs

Request Body:

{
  "model": "gpt2",
  "input": "string or file_id",
  "output_config": {
    "destination": "local or s3://bucket/path",
    "format": "json"
  },
  "requirements": {
    "gpu_type": "v100",
    "gpu_count": 1,
    "min_vram_gb": 16
  },
  "priority": "normal",
  "timeout_seconds": 3600
}

Response:

{
  "job_id": "job_abc123",
  "estimated_cost": 0.05,
  "estimated_time_seconds": 600
}

Get Job Status

GET /v1/jobs/{job_id}

Response:

{
  "job_id": "job_abc123",
  "status": "running",
  "progress": 45,
  "miner_id": "miner_xyz789",
  "created_at": "2026-02-13T10:00:00Z",
  "started_at": "2026-02-13T10:01:00Z",
  "completed_at": null,
  "result": null
}

List Jobs

GET /v1/jobs?status=running&limit=10

Response:

{
  "jobs": [
    {
      "job_id": "job_abc123",
      "status": "running",
      "model": "gpt2"
    }
  ],
  "total": 1,
  "has_more": false
}

Cancel Job

DELETE /v1/jobs/{job_id}

Download Results

GET /v1/jobs/{job_id}/download

Get Job History

GET /v1/jobs/history?from=2026-01-01&to=2026-01-31

Error Codes

Code Description
400 Invalid request
401 Unauthorized
404 Job not found
422 Validation error
429 Rate limited
500 Server error

Rate Limits

  • 60 requests/minute
  • 1000 requests/hour

Next