Get Deriver Status

curl --request GET \
  --url http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "total_work_units": 123,
  "completed_work_units": 123,
  "in_progress_work_units": 123,
  "pending_work_units": 123,
  "sessions": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

workspaces

{workspace_id}

deriver

status

Get Deriver Status

curl --request GET \
  --url http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v2/workspaces/{workspace_id}/deriver/status")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "total_work_units": 123,
  "completed_work_units": 123,
  "in_progress_work_units": 123,
  "pending_work_units": 123,
  "sessions": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id

string

required

ID of the workspace

Query Parameters

observer_id

string | null

Optional observer ID to filter by

sender_id

string | null

Optional sender ID to filter by

session_id

string | null

Optional session ID to filter by

Response

Successful Response

total_work_units

integer

required

Total work units

completed_work_units

integer

required

Completed work units

in_progress_work_units

integer

required

Work units currently being processed

pending_work_units

integer

required

Work units waiting to be processed

sessions

Sessions · object | null

Per-session status when not filtered by session

Show child attributes

API Documentation

workspaces

peers

sessions

messages

observations

webhooks

miscellaneous

Get Deriver Status

Authorizations

Path Parameters

Query Parameters

Response