Skip to main content
GET
/
api
/
v0
/
computers
/
name
/
{name}
Get a computer by name
curl --request GET \
  --url https://api.factory.ai/api/v0/computers/name/{name} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "createdAt": 123,
  "hostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hostname": "<string>",
  "provisioningSteps": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "error": "<string>",
      "startedAt": 123,
      "completedAt": 123,
      "installSessionId": "<string>"
    }
  ],
  "relayClientUrl": "<string>",
  "relayAgentUrl": "<string>",
  "remoteUser": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.factory.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Factory API key or JWT token for authentication

Path Parameters

​
name
string
required

Computer name

Required string length: 1 - 63

Response

Response for status 200

​
id
string
required
​
name
string
required
​
providerType
enum<string>
required
Available options:
byom,
e2b
​
createdAt
number
required
​
hostId
string<uuid>
​
hostname
string
​
status
enum<string>
Available options:
provisioning,
active,
error
​
provisioningSteps
object[]
​
relayClientUrl
string<uri>
​
relayAgentUrl
string<uri>
​
remoteUser
string