Skip to main content
GET
/
workspaces
/
{id}
Get workspace
curl --request GET \
  --url https://www.orgo.ai/api/workspaces/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "production",
  "created_at": "2023-11-07T05:31:56Z",
  "computer_count": 3,
  "computers": [
    {
      "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "name": "agent-1",
      "workspace_id": "550e8400-e29b-41d4-a716-446655440000",
      "os": "linux",
      "ram": 4,
      "cpu": 2,
      "gpu": "none",
      "status": "running",
      "url": "https://orgo.ai/workspaces/a3bb189e-8bf9-3888-9912-ace4e6543002",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}
Returns a workspace by ID, including its computers.

Path parameters

id
string
required
Workspace ID.

Response

Returns the workspace object with an array of computers.
id
string
Workspace identifier.
name
string
Workspace name.
created_at
string
ISO 8601 timestamp.
computer_count
integer
Number of computers.
computers
array
Array of computer objects in this workspace.

Example

curl https://www.orgo.ai/api/workspaces/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer $ORGO_API_KEY"

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "production",
  "created_at": "2024-01-15T10:30:00Z",
  "computer_count": 2,
  "computers": [
    {
      "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "name": "agent-1",
      "os": "linux",
      "ram": 4,
      "cpu": 2,
      "status": "running"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
      "name": "agent-2",
      "os": "linux",
      "ram": 8,
      "cpu": 4,
      "status": "stopped"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key authentication. Get your key at orgo.ai/workspaces

Path Parameters

id
string
required

Workspace ID

Response

Workspace details

id
string

Unique workspace identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string

Workspace name

Example:

"production"

created_at
string<date-time>

Creation timestamp

computer_count
integer

Number of computers in this workspace

Example:

3

computers
object[]