Query Queue Status

This API provides an endpoint to fetch metrics for Rodin queues. The metrics include the number of consumers, jobs awaiting processing, and jobs currently running for each queue.

Request

Note: All requests to this endpoint must include a valid token in the Authorization header for authentication.

Authentication

This API uses a bearer key for authentication. You need to include a valid token in the Authorization header for all requests. Refer to the Login section for how to get an API key for your account.

Authorization: Bearer YOUR_API_KEY

Endpoint

GET /api/v2/queue_status_check

Parameters

No parameters are required for this request.

Response

The response is a JSON object containing metrics for each queue. Each queue's metrics include:

• consumers: The number of consumers listening to the queue.

• job_awaiting: The number of jobs waiting to be processed.

• job_running: The number of jobs currently being processed.

Example Response

{
    "rodin.mesh": {
        "consumers": 1,
        "job_awaiting": 0,
        "job_running": 0
    },
    "rodin.pack": {
        "consumers": 1,
        "job_awaiting": 0,
        "job_running": 0
    },
    "rodin.remesh": {
        "consumers": 1,
        "job_awaiting": 0,
        "job_running": 0
    },
    "rodin.texture": {
        "consumers": 1,
        "job_awaiting": 0,
        "job_running": 0
    }
}

Examples

Python

import requests

RODIN_API_KEY = 'your api key'
headers = {
    'Authorization': f'Bearer {RODIN_API_KEY}'
}
response = requests.get('https://hyperhuman.deemos.com/api/v2/queue_status_check', headers=headers)
print(response.json())

Go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"time"
)

const BaseURI = "https://hyperhuman.deemos.com/api"

var client = &http.Client{Timeout: 10 * time.Second}

type QueueDescriptor struct {
	Consumers   int `json:"consumers"`
	JobAwaiting int `json:"job_awaiting"`
	JobRunning  int `json:"job_running"`
}

type RodinQueueStats struct {
	Mesh    QueueDescriptor `json:"rodin.mesh"`
	Pack    QueueDescriptor `json:"rodin.pack"`
	Remesh  QueueDescriptor `json:"rodin.remesh"`
	Texture QueueDescriptor `json:"rodin.texture"`
}

func QueryRodinQueueStats(token string) (*RodinQueueStats, error) {
	// Create the request
	req, err := http.NewRequest("GET", fmt.Sprintf("%s/v2/queue_status_check", BaseURI), bytes.NewBuffer([]byte{}))
	if err != nil {
		return nil, err
	}

	// Set headers
	req.Header.Set("Authorization", "Bearer "+token)
	req.Header.Set("Content-Type", "application/json")

	// Send the request
	resp, err := client.Do(req)
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	// Decode the response JSON
	var result RodinQueueStats
	err = json.NewDecoder(resp.Body).Decode(&result)
	if err != nil {
		return nil, err
	}

	return &result, nil
}

func main() {
	token := "eyJhbGciOiJIUzI1NiJ9.your.token"

	stats, err := QueryRodinQueueStats(token)
	if err != nil {
		fmt.Println(err)
		return
	}

	fmt.Println(stats)
}