Skip to main content
List All Environments Of An Agent
curl --request GET \
  --url https://{api_endpoint}/api/v1/orchestrate/agents/{agent_id}/environment \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "voice": {
      "enable_on_homepage": false
    },
    "created_by": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_by": "<string>",
    "deleted_at": "2023-11-07T05:31:56Z",
    "current_version": 123,
    "tenant_id": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required

Environment id From The environment table

​
agent_id
string<uuid>
required

Agent id From The environment table

​
name
string
required

Name of the environment

​
description
string
required

Description of what the environment does

​
created_by
string
required

ID of the user who created the environment

​
created_on
string<date-time>
required

Creation timestamp

​
updated_by
string
required

ID of the user who updated the environment

​
updated_at
string<date-time>
required

Last update timestamp

​
tenant_id
string
required

ID of the tenant that owns this environment

​
voice
object | null

Voice configuration for the environment

​
deleted_by
string | null
​
deleted_at
string<date-time> | null
​
current_version
integer | null

Current agent version pointed to this environment