GET /api/optimisation/compute

Account required · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.

Request

No path, query or custom header parameters.

No request body.

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

cURL (POSIX shell)

curl --include \
  --request GET \
  'https://api.weavers.app/api/optimisation/compute' \
  --cookie cookies.txt --cookie-jar cookies.txt

Responses

200 · Successful response.

application/json

200 example · synthetic data

{
  "enabled": false,
  "capacityAvailable": false,
  "acceleratedAvailable": false,
  "twigsPerVcpuHour": 1,
  "twigsPerGiBHour": 1,
  "balance": 1,
  "includedMonthlyVcpuHours": 1,
  "includedRemainingVcpuHours": 1,
  "includedResetsAt": "2025-01-01T00:00:00.000Z",
  "referralCode": null,
  "referralReward": 1
}

View response model

Variant 1: object

enabled required · boolean

capacityAvailable required · boolean

acceleratedAvailable required · boolean

twigsPerVcpuHour required · number

twigsPerGiBHour required · number

balance required · number

includedMonthlyVcpuHours required · number

includedRemainingVcpuHours required · number

includedResetsAt required · string

referralCode required · null

referralReward required · number

Additional fields: JSON values.

Variant 2: object

capacityAvailable required · boolean

acceleratedAvailable required · boolean

twigsPerVcpuHour required · number

twigsPerGiBHour required · number

balance required · number

includedMonthlyVcpuHours required · number

includedRemainingVcpuHours required · number

includedResetsAt required · string

referralCode required · null | string

View referralCode model

Variant 1: null

null

Variant 2: string

string

referralReward required · number

enabled required · boolean

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

401 · Authentication is missing or invalid.

application/json

401 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

403 · Permission, origin or CSRF check failed.

application/json

403 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data

{}

View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string

code optional · string

message optional · string

Additional fields: JSON values.

503 · Service or dependency unavailable.

application/json

503 example · synthetic data

{
  "error": "example"
}

View response model

error required · string

Additional fields: JSON values.