Get Queue Statistics - Open Managed Agents

GET

/

v1

/

environments

/

{environment_id}

/

work

/

stats

Get Queue Statistics

curl --request GET \
  --url http://localhost:38080/v1/environments/{environment_id}/work/stats \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('http://localhost:38080/v1/environments/{environment_id}/work/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "http://localhost:38080/v1/environments/{environment_id}/work/stats"

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

	req.Header.Add("X-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "depth": 123,
  "oldest_queued_at": "<string>",
  "pending": 0,
  "type": "work_queue_stats",
  "workers_polling": 123
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}

Every request requires ?beta=true.

Authorizations

X-Api-Key

string

header

default:sk-ant-local-default

required

OMA workspace API key.

Headers

anthropic-beta

string

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

anthropic-version

string

The version of the OMA API you want to use.

Read more about versioning and our version history here.

authorization

string | null

Path Parameters

environment_id

string

required

Query Parameters

beta

enum<boolean>

required

Selects the beta API contract for this endpoint. Must be true.

Available options:

true

Response

Successful Response

Statistics about the work queue for an environment.

Uses Redis Stream consumer group metrics for O(1) queries.

depth

integer

required

Number of work items waiting to be picked up (lag from consumer group)

oldest_queued_at

string | null

required

RFC 3339 timestamp of oldest item in the work stream (includes both queued and pending items), null if stream empty

pending

integer

default:0

required

Number of work items being processed (polled but not acknowledged)

type

string

default:work_queue_stats

required

The type of object

Allowed value: "work_queue_stats"

workers_polling

integer | null

required

Number of workers that have polled for work in the last 30 seconds. Requires worker_id to be sent with poll requests.

Get Queue Statistics

curl --request GET \
  --url http://localhost:38080/v1/environments/{environment_id}/work/stats \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('http://localhost:38080/v1/environments/{environment_id}/work/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "http://localhost:38080/v1/environments/{environment_id}/work/stats"

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

	req.Header.Add("X-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "depth": 123,
  "oldest_queued_at": "<string>",
  "pending": 0,
  "type": "work_queue_stats",
  "workers_polling": 123
}

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error"
  },
  "request_id": "<string>",
  "type": "error"
}