Link a computer
curl --request POST \
--url https://guidinghand.ai/v1/computers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://guidinghand.ai/v1/computers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://guidinghand.ai/v1/computers"
payload = { "name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"object": "computer",
"id": "K7QM-24XP",
"name": "<string>",
"code": "<string>",
"linked_at": "2023-11-07T05:31:56Z",
"online": true,
"busy": true,
"os": "<string>",
"device_name": "<string>",
"app_version": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"pools": [
"<string>"
],
"expires_in_hours": 72
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"test_case_ids": [
"<string>"
],
"decided_by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"conversation_id": "<string>",
"agent_id": "<string>",
"approval_id": "<string>",
"question_id": "<string>"
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"test_case_ids": [
"<string>"
],
"decided_by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"conversation_id": "<string>",
"agent_id": "<string>",
"approval_id": "<string>",
"question_id": "<string>"
}
}Computers
Link a computer
Makes a link code. On the computer, enter it in the Eager app (1.0.36 or later starts with the computer): it links to the org and reconnects on its own from then on. The code works for 72 hours. Needs the admin role or an API key.
POST
/
v1
/
computers
Link a computer
curl --request POST \
--url https://guidinghand.ai/v1/computers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://guidinghand.ai/v1/computers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://guidinghand.ai/v1/computers"
payload = { "name": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"object": "computer",
"id": "K7QM-24XP",
"name": "<string>",
"code": "<string>",
"linked_at": "2023-11-07T05:31:56Z",
"online": true,
"busy": true,
"os": "<string>",
"device_name": "<string>",
"app_version": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"pools": [
"<string>"
],
"expires_in_hours": 72
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"test_case_ids": [
"<string>"
],
"decided_by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"conversation_id": "<string>",
"agent_id": "<string>",
"approval_id": "<string>",
"question_id": "<string>"
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"test_case_ids": [
"<string>"
],
"decided_by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"conversation_id": "<string>",
"agent_id": "<string>",
"approval_id": "<string>",
"question_id": "<string>"
}
}Authorizations
An org API key (gh_live_…) from Settings → API keys in the console.
Body
application/json
Required string length:
1 - 80Response
The computer, with its code and expires_in_hours.
A computer your org linked with the Eager app. It has nobody at it: agents run desktop tasks on it unattended.
Its code: what an agent’s resources.computers names.
Example:
"K7QM-24XP"
Maximum string length:
80The link code to enter in the app, until it has linked; then null.
Its app is connected now.
Online and running a task.
The pools it’s in.