curl --request GET \
--url https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations \
--header 'Authorization: Bearer <token>'import requests
url = "https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations",
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 := "https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations"
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))
}HttpResponse<String> response = Unirest.get("https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"operations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instanceId": "<string>",
"target": {
"scope": "instance"
},
"method": "session/set_mode",
"capability": "agents.lifecycle",
"transport": "service",
"sequence": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "queued",
"effectState": "queued",
"terminal": true,
"cursor": "<string>",
"progress": {
"sequence": "<string>",
"phase": "<string>",
"current": 1,
"total": 1
},
"cancelRequest": {
"requestedBy": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"reason": "<string>"
},
"projection": {
"revision": "<string>",
"state": "not_applicable",
"platformAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"result": "<unknown>",
"error": {
"code": "AGENT_DEFAULT_MODEL_NOT_CONFIGURED",
"message": "<string>",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effectState": "failed",
"retryMode": "none",
"requestId": "<string>",
"context": {
"activeRuntimeEpoch": "<string>",
"projectionRevision": "<string>",
"retryAfterMs": 1,
"expectedContractRevision": "<string>",
"resourceId": "<string>"
}
}
}
],
"nextCursor": "<string>"
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}List active runtime operations
curl --request GET \
--url https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations \
--header 'Authorization: Bearer <token>'import requests
url = "https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations",
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 := "https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations"
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))
}HttpResponse<String> response = Unirest.get("https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.beeos.ai/api/v1/instances/{instanceId}/operations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"operations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instanceId": "<string>",
"target": {
"scope": "instance"
},
"method": "session/set_mode",
"capability": "agents.lifecycle",
"transport": "service",
"sequence": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "queued",
"effectState": "queued",
"terminal": true,
"cursor": "<string>",
"progress": {
"sequence": "<string>",
"phase": "<string>",
"current": 1,
"total": 1
},
"cancelRequest": {
"requestedBy": "<string>",
"requestedAt": "2023-11-07T05:31:56Z",
"reason": "<string>"
},
"projection": {
"revision": "<string>",
"state": "not_applicable",
"platformAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"result": "<unknown>",
"error": {
"code": "AGENT_DEFAULT_MODEL_NOT_CONFIGURED",
"message": "<string>",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"effectState": "failed",
"retryMode": "none",
"requestId": "<string>",
"context": {
"activeRuntimeEpoch": "<string>",
"projectionRevision": "<string>",
"retryAfterMs": 1,
"expectedContractRevision": "<string>",
"resourceId": "<string>"
}
}
}
],
"nextCursor": "<string>"
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}Authorizations
Pass a user JWT or a oag_ User API Key on the
Authorization: Bearer <token> header. Both are validated by
openapi-gateway against the Auth service.
Both credential types are user-scoped: every key (and every JWT) is bound to exactly one owner, and every route grants the caller full access to that owner's own resources. Cross-tenant access is denied by owner-ACL inside the handlers — there is no per-route scope vocabulary on this API.
Removed in v1.1.0: the legacy
agents:*/tasks:*/files:*/instances:*scope set has been dropped together with the403 insufficient_scopeerror. Existingoag_keys automatically gain full owner-level access and do not need to be re-issued. SDK calls that previously passedscopestocreateAPIKeyshould drop the argument. See the changelog at the bottom of this spec for the full migration note.
Path Parameters
128Query Parameters
active 1281 <= x <= 200