Open, renew or close a scoped read session on a Dataset Version

POST

api

dataset-versions

{id}

access

Open, renew or close a scoped read session on a Dataset Version

curl --request POST \
  --url https://api.nitsor.com/api/v1/dataset-versions/{id}/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignment": {
    "numWorkers": 512,
    "rank": 511,
    "worker": 511,
    "worldSize": 512
  },
  "installationId": "<string>",
  "expectedManifestHash": "<string>"
}
'

import requests

url = "https://api.nitsor.com/api/v1/dataset-versions/{id}/access"

payload = {
    "assignment": {
        "numWorkers": 512,
        "rank": 511,
        "worker": 511,
        "worldSize": 512
    },
    "installationId": "<string>",
    "expectedManifestHash": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    assignment: {numWorkers: 512, rank: 511, worker: 511, worldSize: 512},
    installationId: '<string>',
    expectedManifestHash: '<string>'
  })
};

fetch('https://api.nitsor.com/api/v1/dataset-versions/{id}/access', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nitsor.com/api/v1/dataset-versions/{id}/access",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'assignment' => [
        'numWorkers' => 512,
        'rank' => 511,
        'worker' => 511,
        'worldSize' => 512
    ],
    'installationId' => '<string>',
    'expectedManifestHash' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nitsor.com/api/v1/dataset-versions/{id}/access"

	payload := strings.NewReader("{\n  \"assignment\": {\n    \"numWorkers\": 512,\n    \"rank\": 511,\n    \"worker\": 511,\n    \"worldSize\": 512\n  },\n  \"installationId\": \"<string>\",\n  \"expectedManifestHash\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nitsor.com/api/v1/dataset-versions/{id}/access")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assignment\": {\n    \"numWorkers\": 512,\n    \"rank\": 511,\n    \"worker\": 511,\n    \"worldSize\": 512\n  },\n  \"installationId\": \"<string>\",\n  \"expectedManifestHash\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/dataset-versions/{id}/access")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assignment\": {\n    \"numWorkers\": 512,\n    \"rank\": 511,\n    \"worker\": 511,\n    \"worldSize\": 512\n  },\n  \"installationId\": \"<string>\",\n  \"expectedManifestHash\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "allowedShards": [
    511
  ],
  "assignedMembers": 512,
  "manifestHash": "<string>",
  "paddedMembers": [
    511
  ],
  "sessionExpiresAt": "2023-11-07T05:31:56Z",
  "sessionId": "<string>",
  "versionId": "<string>",
  "brokers": [
    {
      "kind": "nitsor-worker",
      "url": "<string>",
      "connectionId": "<string>"
    }
  ],
  "expiresAt": "2023-11-07T05:31:56Z",
  "lease": "<string>",
  "outcome": "started"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Authorizations

Authorization

string

header

required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Path Parameters

string

required

The Dataset Version's versionId.

Required string length: 1 - 200

Body

application/json

Option 1
Option 2
Option 3

assignment

object

required

Show child attributes

installationId

string

required

Required string length: 1 - 200

expectedManifestHash

string

Pattern: ^sha256:([0-9a-f]{64})$

Response

Open, renew or close a scoped read session on a Dataset Version

Option 1
Option 2
Option 3

allowedShards

integer[]

required

Maximum array length: 1024

Required range: 0 <= x <= 1023

assignedMembers

integer

required

Required range: 0 <= x <= 1024

manifestHash

string

required

Pattern: ^sha256:([0-9a-f]{64})$

paddedMembers

integer[]

required

Maximum array length: 1024

Required range: 0 <= x <= 1023

sessionExpiresAt

string<date-time>

required

RFC 3339 timestamp in UTC: the offset is Z or +00:00; any other offset is refused.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$

sessionId

string

required

Required string length: 1 - 200

versionId

string

required

Required string length: 1 - 200

brokers

object[]

required

Required array length: 1 - 1024 elements

Show child attributes

expiresAt

string<date-time>

required

RFC 3339 timestamp in UTC: the offset is Z or +00:00; any other offset is refused.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$

lease

string

required

Required string length: 1 - 16384

outcome

string

required

Allowed value: "started"

Open, renew or close a scoped read session on a Dataset Version

curl --request POST \
  --url https://api.nitsor.com/api/v1/dataset-versions/{id}/access \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assignment": {
    "numWorkers": 512,
    "rank": 511,
    "worker": 511,
    "worldSize": 512
  },
  "installationId": "<string>",
  "expectedManifestHash": "<string>"
}
'

import requests

url = "https://api.nitsor.com/api/v1/dataset-versions/{id}/access"

payload = {
    "assignment": {
        "numWorkers": 512,
        "rank": 511,
        "worker": 511,
        "worldSize": 512
    },
    "installationId": "<string>",
    "expectedManifestHash": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    assignment: {numWorkers: 512, rank: 511, worker: 511, worldSize: 512},
    installationId: '<string>',
    expectedManifestHash: '<string>'
  })
};

fetch('https://api.nitsor.com/api/v1/dataset-versions/{id}/access', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nitsor.com/api/v1/dataset-versions/{id}/access",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'assignment' => [
        'numWorkers' => 512,
        'rank' => 511,
        'worker' => 511,
        'worldSize' => 512
    ],
    'installationId' => '<string>',
    'expectedManifestHash' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nitsor.com/api/v1/dataset-versions/{id}/access"

	payload := strings.NewReader("{\n  \"assignment\": {\n    \"numWorkers\": 512,\n    \"rank\": 511,\n    \"worker\": 511,\n    \"worldSize\": 512\n  },\n  \"installationId\": \"<string>\",\n  \"expectedManifestHash\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nitsor.com/api/v1/dataset-versions/{id}/access")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assignment\": {\n    \"numWorkers\": 512,\n    \"rank\": 511,\n    \"worker\": 511,\n    \"worldSize\": 512\n  },\n  \"installationId\": \"<string>\",\n  \"expectedManifestHash\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/dataset-versions/{id}/access")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assignment\": {\n    \"numWorkers\": 512,\n    \"rank\": 511,\n    \"worker\": 511,\n    \"worldSize\": 512\n  },\n  \"installationId\": \"<string>\",\n  \"expectedManifestHash\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "allowedShards": [
    511
  ],
  "assignedMembers": 512,
  "manifestHash": "<string>",
  "paddedMembers": [
    511
  ],
  "sessionExpiresAt": "2023-11-07T05:31:56Z",
  "sessionId": "<string>",
  "versionId": "<string>",
  "brokers": [
    {
      "kind": "nitsor-worker",
      "url": "<string>",
      "connectionId": "<string>"
    }
  ],
  "expiresAt": "2023-11-07T05:31:56Z",
  "lease": "<string>",
  "outcome": "started"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Reference

API operations

Open, renew or close a scoped read session on a Dataset Version

Authorizations

Path Parameters

Body

Response