Skip to main content
GET
/
api
/
v1
/
instances
List the caller's instances
curl --request GET \
  --url https://openapi.beeos.ai/api/v1/instances \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [],
  "total": 0
}

Authorizations

​
Authorization
string
header
required

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 the 403 insufficient_scope error. Existing oag_ keys automatically gain full owner-level access and do not need to be re-issued. SDK calls that previously passed scopes to createAPIKey should drop the argument. See the changelog at the bottom of this spec for the full migration note.

Query Parameters

​
page
integer<int32>
Required range: x >= 0
​
pageSize
integer<int32>
Required range: 0 <= x <= 200
​
status
string
​
providerId
string
​
agentFramework
string
​
clusterId
string
​
search
string

Response

Paginated list of instances ({ success, data, total }).

​
success
boolean
required
​
data
object[]
required
​
total
integer<int64>