API docs by Redocly

Codex API (0.0.1)

Download OpenAPI specification:

List of endpoints and interfaces available to Codex API users

Marketplace

Marketplace information and operations

Returns active slots

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns active slot with id {slotId} for the host

Authorizations:
None
path Parameters
slotId
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File to be downloaded.

Responses

Response samples

Content type
application/json
{
  • "slotIndex": 0,
  • "requestId": "0x...",
  • "request": {
    },
  • "reservation": {
    },
  • "state": "SaleCancelled"
}

Returns storage that is for sale

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Offers storage for sale

Authorizations:
None
Request Body schema: application/json
totalSize
required
integer <int64>

Total size of availability's storage in bytes

duration
required
integer <int64> (Duration)

The duration of the request in seconds

minPricePerBytePerSecond
required
string

Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string

totalCollateral
required
string

Total collateral (in amount of tokens) that can be used for matching requests

enabled
boolean
Default: true

Enable the ability to receive sales on this availability.

until
integer
Default: 0

Specifies the latest timestamp, after which the availability will no longer host any slots. If set to 0, there will be no restrictions.

Responses

Request samples

Content type
application/json
{
  • "totalSize": 0,
  • "duration": 0,
  • "minPricePerBytePerSecond": "string",
  • "totalCollateral": "string",
  • "enabled": true,
  • "until": 0
}

Response samples

Content type
application/json
{
  • "totalSize": 0,
  • "duration": 0,
  • "minPricePerBytePerSecond": "string",
  • "totalCollateral": "string",
  • "enabled": true,
  • "until": 0,
  • "id": "0x...",
  • "freeSize": 0,
  • "totalRemainingCollateral": "string"
}

Updates availability

The new parameters will be only considered for new requests. Existing Requests linked to this Availability will continue as is.

Authorizations:
None
path Parameters
id
required
string

ID of Availability

Request Body schema: application/json
totalSize
required
integer <int64>

Total size of availability's storage in bytes

duration
required
integer <int64> (Duration)

The duration of the request in seconds

minPricePerBytePerSecond
required
string

Minimal price per byte per second paid (in amount of tokens) for the hosted request's slot for the request's duration as decimal string

totalCollateral
required
string

Total collateral (in amount of tokens) that can be used for matching requests

enabled
boolean
Default: true

Enable the ability to receive sales on this availability.

until
integer
Default: 0

Specifies the latest timestamp, after which the availability will no longer host any slots. If set to 0, there will be no restrictions.

Responses

Request samples

Content type
application/json
{
  • "totalSize": 0,
  • "duration": 0,
  • "minPricePerBytePerSecond": "string",
  • "totalCollateral": "string",
  • "enabled": true,
  • "until": 0
}

Get availability's reservations

Return's list of Reservations for ongoing Storage Requests that the node hosts.

Authorizations:
None
path Parameters
id
required
string

ID of Availability

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new Request for storage

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

CID of the uploaded data that should be stored

Request Body schema: application/json
duration
required
integer <int64> (Duration)

The duration of the request in seconds

pricePerBytePerSecond
required
string (PricePerBytePerSecond)

The amount of tokens paid per byte per second per slot to hosts the client is willing to pay

proofProbability
required
string (ProofProbability)

How often storage proofs are required as decimal string

nodes
integer >= 3
Default: 3

Minimal number of nodes the content should be stored on

tolerance
integer >= 1
Default: 1

Additional number of nodes on top of the nodes property that can be lost before pronouncing the content lost

collateralPerByte
required
string (CollateralPerByte)

Number as decimal string that represents how much collateral per byte is asked from hosts that wants to fill a slots

expiry
required
integer <int64>

Number that represents expiry threshold in seconds from when the Request is submitted. When the threshold is reached and the Request does not find requested amount of nodes to host the data, the Request is voided. The number of seconds can not be higher then the Request's duration itself.

Responses

Request samples

Content type
application/json
{
  • "duration": 0,
  • "pricePerBytePerSecond": "string",
  • "proofProbability": "string",
  • "nodes": 3,
  • "tolerance": 1,
  • "collateralPerByte": "string",
  • "expiry": 0
}

Returns list of purchase IDs

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • "string"
]

Returns purchase details

Authorizations:
None
path Parameters
id
required
string

Hexadecimal ID of a Purchase

Responses

Response samples

Content type
application/json
{
  • "state": "cancelled",
  • "error": "string",
  • "request": {
    },
  • "requestId": "0x..."
}

Data

Data operations

Lists manifest CIDs stored locally in node.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Upload a file in a streaming manner. Once finished, the file is stored in the node and can be retrieved by any node in the network using the returned CID.

Authorizations:
None
header Parameters
content-type
string
Example: image/png

The content type of the file. Must be valid.

content-disposition
string
Example: attachment; filename="codex.png"

The content disposition used to send the filename.

Request Body schema: application/octet-stream
string <binary>

Responses

Download a file from the local node in a streaming manner. If the file is not available locally, a 404 is returned.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File to be downloaded.

Responses

Download a file from the network to the local node if it's not available locally. Note: Download is performed async. Call can return before download is completed.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File to be downloaded.

Responses

Response samples

Content type
application/json
{
  • "cid": "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
  • "manifest": {
    }
}

Download a file from the network in a streaming manner. If the file is not available locally, it will be retrieved from other nodes in the network if able.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File to be downloaded.

Responses

Download only the dataset manifest from the network to the local node if it's not available locally.

Authorizations:
None
path Parameters
cid
required
string (Cid)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

File for which the manifest is to be downloaded.

Responses

Response samples

Content type
application/json
{
  • "cid": "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
  • "manifest": {
    }
}

Gets a summary of the storage space allocation of the node.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "totalBlocks": 0,
  • "quotaMaxBytes": 0,
  • "quotaUsedBytes": 0,
  • "quotaReservedBytes": 0
}

Node

Node management

Connect to a peer

If addrs param is supplied, it will be used to dial the peer, otherwise the peerId is used to invoke peer discovery, if it succeeds the returned addresses will be used to dial.

Authorizations:
None
path Parameters
peerId
required
string (PeerId)
Example: QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N

Peer that should be dialed.

query Parameters
addrs
Array of strings or null (MultiAddress)
Example: addrs=/ip4/127.0.0.1/tcp/8080

If supplied, it will be used to dial the peer. The address has to target the listening address of the peer, which is specified with the --listen-addrs CLI flag.

Responses

Get Node's SPR

Authorizations:
None

Responses

Response samples

Content type
No sample

Get Node's PeerID

Authorizations:
None

Responses

Response samples

Content type
No sample

Debug

Debugging configuration

Set log level at run time

Authorizations:
None
query Parameters
level
required
string (LogLevel)
Example: level=DEBUG

One of the log levels: TRACE, DEBUG, INFO, NOTICE, WARN, ERROR or FATAL

Responses

Gets node information

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "id": "QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N",
  • "addrs": [
    ],
  • "repo": "string",
  • "spr": "string",
  • "announceAddresses": [
    ],
  • "table": {
    },
  • "codex": {
    }
}