List Work Items - Open Managed Agents

GET

/

v1

/

environments

/

{environment_id}

/

work

List Work Items

curl --request GET \
  --url http://localhost:38080/v1/environments/{environment_id}/work \
  --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', 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"

	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))

}

{
  "data": [
    {
      "acknowledged_at": "<string>",
      "created_at": "<string>",
      "data": {
        "id": "<string>",
        "type": "session"
      },
      "environment_id": "<string>",
      "id": "<string>",
      "latest_heartbeat_at": "<string>",
      "metadata": {},
      "secret": "<string>",
      "started_at": "<string>",
      "state": "queued",
      "stop_requested_at": "<string>",
      "stopped_at": "<string>",
      "type": "work"
    }
  ],
  "next_page": "<string>"
}

{
  "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

limit

integer

default:20

Maximum number of work items to return

Required range: 1 <= x <= 1000

page

string | null

Opaque cursor from previous response for pagination

Response

Successful Response

Response when listing work items with cursor-based pagination.

data

SelfHostedWork · object[]

required

List of work items

Show child attributes

next_page

string | null

required

Opaque cursor for fetching the next page of results

List Work Items

curl --request GET \
  --url http://localhost:38080/v1/environments/{environment_id}/work \
  --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', 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"

	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))

}

{
  "data": [
    {
      "acknowledged_at": "<string>",
      "created_at": "<string>",
      "data": {
        "id": "<string>",
        "type": "session"
      },
      "environment_id": "<string>",
      "id": "<string>",
      "latest_heartbeat_at": "<string>",
      "metadata": {},
      "secret": "<string>",
      "started_at": "<string>",
      "state": "queued",
      "stop_requested_at": "<string>",
      "stopped_at": "<string>",
      "type": "work"
    }
  ],
  "next_page": "<string>"
}

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