Crynux Network
HomeBlogGitHubTwitterDiscordNetstats
  • Crynux Network
  • Releases
    • Helium Network
    • Hydrogen Network
  • System Design
    • Network Architecture
    • Consensus Protocol
      • Inference Task Validation
      • Training/FT Task Validation
    • Verifiable Secret Sampling
    • Task Lifecycle
      • Task State Transitions
    • Task Dispatching
    • Task Pricing
    • Quality of Service (QoS)
    • Model Distribution
  • Node Hosting
    • Start a Node
      • Start a Node - Windows
      • Start a Node - Mac
      • Start a Node - Linux
      • Start a Node - Docker
      • Start a Node - Vast
    • Get the Test CNX Tokens
    • Private Key Security
    • Assign GPU to the Node
    • Proxy Settings
    • Docker Compose Options
    • Advanced Configuration
  • Application Development
    • How to Run LLM using Crynux Network
    • Application Workflow
    • Execute Tasks
      • Text-to-Image Task
      • Text-to-Text Task
      • Text-to-Music Task
      • Text-to-Video Task
      • Fine-Tuning Task
    • Crynux Bridge
    • API Specification of the Relay
    • Crynux SDK
  • Crynux Token
    • Wallet Configuration
      • Metamask
  • Troubleshooting
    • FAQ
    • Locate the Error Message
    • Exceptions in WebUI
  • Misc
    • Privacy Policy
Powered by GitBook
On this page
Edit on GitHub
  1. Application Development

API Specification of the Relay

The OpenAPI specification of the Relay

PreviousCrynux BridgeNextCrynux SDK

Last updated 10 months ago

Resources

The JSON schema of the OpenAPI Specification of the Relay can be found at:

The rendered document of the specification can be accessed at:

API List

Task Related APIs

Network Stats Related APIs

Other APIs

https://dy.relay.crynux.ai/openapi.jsondy.relay.crynux.ai
https://dy.relay.crynux.ai/static/api_docs.html

Get total TFLOPS of the network

get
Responses
200
OK
application/json
400
validation errors
application/json
get
GET /v1/network HTTP/1.1
Host: 
Accept: */*
{
  "data": {
    "tflops": 1
  },
  "message": "text"
}

Get the info of all the nodes in the network

get
Query parameters
startinteger · int32Optional
totalinteger · int32 · min: 1 · max: 100Required
Responses
200
OK
application/json
400
validation errors
application/json
get
GET /v1/network/nodes/data?total=1 HTTP/1.1
Host: 
Accept: */*
{
  "data": [
    {
      "address": "text",
      "balance": {},
      "card_model": "text",
      "qos": 1,
      "v_ram": 1
    }
  ],
  "message": "text"
}

Get total nodes number in the network

get
Responses
200
OK
application/json
400
validation errors
application/json
get
GET /v1/network/nodes/number HTTP/1.1
Host: 
Accept: */*
{
  "data": {
    "active_nodes": 1,
    "all_nodes": 1,
    "busy_nodes": 1
  },
  "message": "text"
}

Get total task number in the network

get
Responses
200
OK
application/json
400
validation errors
application/json
get
GET /v1/network/tasks/number HTTP/1.1
Host: 
Accept: */*
{
  "data": {
    "queued_tasks": 1,
    "running_tasks": 1,
    "total_tasks": 1
  },
  "message": "text"
}

Get current unix timestamp of server

get
Responses
200
OK
application/json
400
validation errors
application/json
get
GET /v1/now HTTP/1.1
Host: 
Accept: */*
{
  "data": {
    "now": 1
  },
  "message": "text"
}
  • Resources
  • API List
  • Task Related APIs
  • Network Stats Related APIs
  • GETGet total TFLOPS of the network
  • GETGet the info of all the nodes in the network
  • GETGet total nodes number in the network
  • GETGet total task number in the network
  • Other APIs
  • GETGet current unix timestamp of server