Agentuity Documentation

Manage compute nodes and organization authentication enrollment.

Region

https://catalyst-usw.agentuity.cloud

Authentication

All requests require a Bearer token. Pass your SDK key in the Authorization header.

Header	Value
`Authorization`	`Bearer YOUR_SDK_KEY`

You can find your SDK key in the Agentuity Console under your project settings.

Machine Management

List Machines

List all machines visible to the authenticated user.

GET/machine

https://catalyst-usw.agentuity.cloud/machine

Response

Returns all machines visible to the authenticated user.

Status	Description
200	Machines returned
401	Unauthorized — invalid or missing Bearer token

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/machine' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Get Machine

Get details for a specific machine.

GET/machine/{machineId}

https://catalyst-usw.agentuity.cloud/machine/{machineId}

Parameters

path

Name	Type	Required	Description
`machineId`	string	Yes	Machine ID

Response

Returns machine details.

Status	Description
200	Machine returned
401	Unauthorized — invalid or missing Bearer token
404	Machine not found

Response Fields

Field	Type	Description
`id`	string	Unique identifier for the machine.
`instanceId`	string \| null	Cloud provider instance ID. (optional)
`privateIPv4`	string \| null	Private IPv4 address of the machine. (optional)
`availabilityZone`	string \| null	Cloud provider availability zone. (optional)
`instanceType`	string \| null	Cloud provider instance type (e.g., n1-standard-2). (optional)
`instanceTags`	string[] \| null	Tags assigned to the cloud instance. (optional)
`deploymentCount`	number	Number of active deployments on this machine. (optional)
`status`	string	Current status of the machine (e.g., running, stopped, errored).
`provider`	string	Cloud provider (e.g., gcp, aws).
`region`	string	Cloud region where the machine is deployed.
`startedAt`	string \| null	ISO 8601 timestamp when the machine was started. (optional)
`stoppedAt`	string \| null	ISO 8601 timestamp when the machine was stopped. (optional)
`pausedAt`	string \| null	ISO 8601 timestamp when the machine was paused. (optional)
`erroredAt`	string \| null	ISO 8601 timestamp when the machine entered error state. (optional)
`error`	string \| null	Error message if the machine is in an error state. (optional)
`orgId`	string \| null	Organization ID that owns this machine. (optional)
`orgName`	string \| null	Organization name that owns this machine. (optional)
`createdAt`	string	ISO 8601 timestamp when the machine was created.
`updatedAt`	string \| null	ISO 8601 timestamp when the machine was last updated. (optional)
`metadata`	object \| null	Arbitrary metadata associated with the machine. (optional)

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/machine/mch_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Delete Machine

Delete a machine by ID.

DELETE/machine/{machineId}

https://catalyst-usw.agentuity.cloud/machine/{machineId}

Parameters

path

Name	Type	Required	Description
`machineId`	string	Yes	Machine ID

Response

Empty response on success.

Status	Description
204	Machine deleted
401	Unauthorized — invalid or missing Bearer token
404	Machine not found

Example

curl -X DELETE 'https://catalyst-usw.agentuity.cloud/machine/mch_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

List Machine Deployments

List all deployments currently running on a specific machine.

GET/machine/deployments/{machineId}

https://catalyst-usw.agentuity.cloud/machine/deployments/{machineId}

Parameters

path

Name	Type	Required	Description
`machineId`	string	Yes	Machine ID

Response

Returns all deployments currently running on the specified machine.

Status	Description
200	Deployments returned
401	Unauthorized — invalid or missing Bearer token
404	Machine not found

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/machine/deployments/mch_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Auth Enrollment

Enroll Organization

Enroll an organization for machine authentication.

POST/cli/auth/org/enroll

https://catalyst-usw.agentuity.cloud/cli/auth/org/enroll

Request Body

Enrollment payload with organization ID and public key.

Field	Type	Description
`orgId`	string	Organization ID
`publicKey`	string	Public key for machine authentication

Response

Returns the enrolled organization ID.

Status	Description
200	Organization enrolled
401	Unauthorized — invalid or missing Bearer token

Response Fields

Field	Type	Description
`orgId`	string	The enrolled organization ID

Example

curl -X POST 'https://catalyst-usw.agentuity.cloud/cli/auth/org/enroll' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "orgId": "org_abc123",
  "publicKey": "ssh-ed25519 AAAA..."
}'

Get Enrollment Status

Get the enrollment status for an organization.

GET/cli/auth/org/status/{orgId}

https://catalyst-usw.agentuity.cloud/cli/auth/org/status/{orgId}

Parameters

path

Name	Type	Required	Description
`orgId`	string	Yes	Organization ID

Response

Returns the enrollment status. A null publicKey means not enrolled.

Status	Description
200	Enrollment status returned
401	Unauthorized — invalid or missing Bearer token
404	Organization not found

Response Fields

Field	Type	Description
`publicKey`	string \| null	Public key or null if not enrolled

Example

curl -X GET 'https://catalyst-usw.agentuity.cloud/cli/auth/org/status/org_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'

Unenroll Organization

Remove enrollment for an organization.

DELETE/cli/auth/org/unenroll/{orgId}

https://catalyst-usw.agentuity.cloud/cli/auth/org/unenroll/{orgId}

Parameters

path

Name	Type	Required	Description
`orgId`	string	Yes	Organization ID

Response

Empty response on success.

Status	Description
204	Organization unenrolled
401	Unauthorized — invalid or missing Bearer token
404	Organization not found

Example

curl -X DELETE 'https://catalyst-usw.agentuity.cloud/cli/auth/org/unenroll/org_abc123' \
  -H 'Authorization: Bearer $AGENTUITY_SDK_KEY'