Compute

Endpoint: https://api.neocu.com/v1/compute

Method: GET

Content Type: application/json

Authentication: api-key

Description: Get the balance of remaining compute for your account.

Authentication:

This endpoint requires API Key authentication. You must include your API key in the api-key header of your request.

Request Headers:

Header	Type	Required	Description
api-key	String	Yes	Your organization's API key for authentication.

Response Codes:

HTTP Status Code	Description	Response Body (JSON)
200 OK	Compute balance successfully retrieved.	See "Response Body (Success - 200 OK)" below.
401 Unauthorized	Authentication failed - Missing or invalid API Key.	json { "error": "API key is missing in headers. Please provide an API key to access this service." } - Returned when the api-key header is missing.
500 Internal Server Error	An unexpected error occurred on the server.	json { "error": "System Error. Please try again" }

Response Body (Success - 200 OK):

{
  "isSuccess": true
  "compute": number
}

Response Body Fields:

Field	Type	Description
isSuccess	Boolean	Indicates whether the request was successful (always true for a 200 OK response).
compute	Number	The compute balance associated with the organization. Represents the remaining compute units.

Example Request:

GET /v1/compute
Host: api.neocu.com
api-key: YOUR_API_KEY_HERE

Example Response (200 OK):

{
  "isSuccess": true,
  "compute": 1234.56
}