Acknowledge Work - Open Managed Agents

POST

/

v1

/

environments

/

{environment_id}

/

work

/

{work_id}

/

ack

Acknowledge Work

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

import requests

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

headers = {"X-Api-Key": "<api-key>"}

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

print(response.text)

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

fetch('http://localhost:38080/v1/environments/{environment_id}/work/{work_id}/ack', 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/{work_id}/ack"

	req, _ := http.NewRequest("POST", 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))

}

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

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

work_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

Work resource representing a unit of work in a self-hosted environment.

Work items are queued when sessions are created or when long-dormant sessions receive new messages. The environment worker polls for work to execute in a self-hosted sandbox.

acknowledged_at

string | null

required

RFC 3339 timestamp when the work item was acknowledged and assigned to a self-hosted sandbox

created_at

string

required

RFC 3339 timestamp when work was created

data

SessionWorkData · object

required

The actual work to be performed

Show child attributes

environment_id

string

required

Environment identifier this work belongs to (e.g., env_...)

id

string

required

Work identifier (e.g., 'work_...')

latest_heartbeat_at

string | null

required

RFC 3339 timestamp of the most recent heartbeat

metadata

Metadata · object

required

User-provided metadata key-value pairs associated with this work item

Show child attributes

secret

string | null

required

Credential payload used by the environment worker to execute this work item. May be populated when polling for work; null on all other retrieval paths.

started_at

string | null

required

RFC 3339 timestamp when work execution started

state

enum<string>

required

Current state of the work item

Available options:

queued,

starting,

active,

stopping,

stopped

stop_requested_at

string | null

required

RFC 3339 timestamp when stop was requested

stopped_at

string | null

required

RFC 3339 timestamp when work execution stopped

type

string

default:work

required

The type of object (always 'work')

Allowed value: "work"

Acknowledge Work

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

import requests

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

headers = {"X-Api-Key": "<api-key>"}

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

print(response.text)

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

fetch('http://localhost:38080/v1/environments/{environment_id}/work/{work_id}/ack', 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/{work_id}/ack"

	req, _ := http.NewRequest("POST", 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))

}

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

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