API Specification of the Relay

The OpenAPI specification of the Relay

Resources

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

https://dy.relay.crynux.ai/openapi.jsondy.relay.crynux.ai

The rendered document of the specification can be accessed at:

https://dy.relay.crynux.ai/static/api_docs.htmldy.relay.crynux.ai

API List

Task Related APIs

Network Stats Related APIs

Get total TFLOPS of the network

get

Responses

200

OK

application/json

messagestringOptional

The response message. Will be 'success' or a detailed error type

400

validation errors

application/json

get

/v1/network

HTTPcURLJavaScriptPython

GET /v1/network HTTP/1.1
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

messagestringOptional

The response message. Will be 'success' or a detailed error type

400

validation errors

application/json

get

/v1/network/nodes/data

HTTPcURLJavaScriptPython

GET /v1/network/nodes/data?total=1 HTTP/1.1
Accept: */*

{
  "data": [
    {
      "address": "text",
      "balance": "text",
      "card_model": "text",
      "prob_weight": 1,
      "qos_score": 1,
      "staking": "text",
      "staking_score": 1,
      "v_ram": 1
    }
  ],
  "message": "text"
}

Get total nodes number in the network

get

Responses

200

OK

application/json

messagestringOptional

The response message. Will be 'success' or a detailed error type

400

validation errors

application/json

get

/v1/network/nodes/number

HTTPcURLJavaScriptPython

GET /v1/network/nodes/number HTTP/1.1
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

messagestringOptional

The response message. Will be 'success' or a detailed error type

400

validation errors

application/json

get

/v1/network/tasks/number

HTTPcURLJavaScriptPython

GET /v1/network/tasks/number HTTP/1.1
Accept: */*

{
  "data": {
    "queued_tasks": 1,
    "running_tasks": 1,
    "total_tasks": 1
  },
  "message": "text"
}

Other APIs

Get current unix timestamp of server

get

Responses

200

OK

application/json

messagestringOptional

The response message. Will be 'success' or a detailed error type

400

validation errors

application/json

get

/v1/now

HTTPcURLJavaScriptPython

GET /v1/now HTTP/1.1
Accept: */*

{
  "data": {
    "now": 1
  },
  "message": "text"
}