Skip to main content

List environments

List managed environments in the current workspace with cursor pagination.

Endpoint

GET /agents/environments Lists managed environments in the current workspace with cursor pagination. A successful call returns 200 and a list envelope.

Query parameters

limit integer (optional)Number of items per page, default 20, range 1–100order string (optional)Sort direction, asc or desc, default descafter string (optional)The last_id from the previous page; the cursor item is excludedtype string (optional)Environment type; openai_hosted or bailian_hosted; the value is validated but does not filter results, so do not rely on it to distinguish managed environmentsbefore currently returns 400.

Request example

curl -sS --get "$BASE_URL/agents/environments" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "OpenAI-Beta: agents=v1" \
  --data-urlencode "limit=20" \
  --data-urlencode "order=desc"

Response fields

object stringList object type, fixed as listdata arrayEnvironments on the current page; can be emptyfirst_id string / nullID of the first item on the page; null for an empty pagelast_id string / nullID of the last item on the page; null for an empty pagehas_more booleanWhether the current direction has another pageAn empty list:

Response example

{
  "object": "list",
  "data": [{
    "id": "ccarenv_xxx",
    "object": "agent.environment",
    "type": "openai_hosted",
    "status": "ready",
    "files": [],
    "skills": [],
    "plugins": []
  }],
  "first_id": "ccarenv_xxx",
  "last_id": "ccarenv_xxx",
  "has_more": false
}

Error codes

HTTP statusError type / codeSolution
400invalid_request_error / invalid_request_errorFix limit and order as described in the query parameters, and remove before
401invalid_request_error / workspace_required or user_requiredUse an API key for the current workspace
The error body has the shape {"error":{"type","code","message","param"}}. Gateway errors can use a different structure.