Estimate time, meter units, and list price for a planned action

POST

/v1/usage/estimates

curl -X POST 'https://api.embodiflow.io/v1/usage/estimates' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "descriptor": "upload_plan",
    "uploadPlanId": "00000000-0000-0000-0000-000000000000",
    "workflowRevisionId": "00000000-0000-0000-0000-000000000000",
    "algorithmRevisionId": "00000000-0000-0000-0000-000000000000",
    "itemCount": 0,
    "recordedSeconds": 0,
    "projectVersionId": "00000000-0000-0000-0000-000000000000",
    "format": "string",
    "options": {},
    "modelImageRevisionId": "00000000-0000-0000-0000-000000000000",
    "flavor": "string",
    "steps": 0,
    "modelVersionId": "00000000-0000-0000-0000-000000000000",
    "split": "string",
    "episodeId": "00000000-0000-0000-0000-000000000000"
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Request body

Content-Typeapplication/json

descriptorstringrequired
Allowed values
upload_plan
workflow_run
materialize
export
training
evaluation
try
endpoint_hour
uploadPlanIdstring (uuid)
workflowRevisionIdstring (uuid)
algorithmRevisionIdstring (uuid)
itemCountnumber
recordedSecondsnumber
projectVersionIdstring (uuid)
formatstring
optionsobject
modelImageRevisionIdstring (uuid)
flavorstring
stepsnumber
modelVersionIdstring (uuid)
splitstring
episodeIdstring (uuid)

Responses

Success

dataobjectrequired
- durationSecondsnumberrequired
- unitsarray<UsageEstimateUnitDto>required
- priceobjectrequired
- basisstringrequired
  Allowed values
  coefficient
  history
  declared_resources
- evidencearray<string>required
- limitCheckobjectrequired

Response example

{
  "data": {
    "durationSeconds": 0,
    "units": [
      {
        "meterCode": "string",
        "quantity": 0
      }
    ],
    "price": {
      "amountMinor": 0,
      "currency": "string"
    },
    "basis": "coefficient",
    "evidence": [
      "string"
    ],
    "limitCheck": {
      "wouldExceed": false,
      "remainingBytes": 0
    }
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1

curl -X POST 'https://api.embodiflow.io/v1/usage/estimates' \ -H 'Authorization: Bearer $EMBODIFLOW_PAT' \ -H 'Content-Type: application/json' \ -d '{ "descriptor": "upload_plan", "uploadPlanId": "00000000-0000-0000-0000-000000000000", "workflowRevisionId": "00000000-0000-0000-0000-000000000000", "algorithmRevisionId": "00000000-0000-0000-0000-000000000000", "itemCount": 0, "recordedSeconds": 0, "projectVersionId": "00000000-0000-0000-0000-000000000000", "format": "string", "options": {}, "modelImageRevisionId": "00000000-0000-0000-0000-000000000000", "flavor": "string", "steps": 0, "modelVersionId": "00000000-0000-0000-0000-000000000000", "split": "string", "episodeId": "00000000-0000-0000-0000-000000000000" }'

{ "data": { "durationSeconds": 0, "units": [ { "meterCode": "string", "quantity": 0 } ], "price": { "amountMinor": 0, "currency": "string" }, "basis": "coefficient", "evidence": [ "string" ], "limitCheck": { "wouldExceed": false, "remainingBytes": 0 } } }