Create a model image definition
POST
/v1/model-image-definitionscurl -X POST 'https://api.embodiflow.io/v1/model-image-definitions' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"projectId": "00000000-0000-0000-0000-000000000000",
"code": "string",
"name": "string",
"description": "string",
"imageKind": "training",
"category": "string",
"tags": [
"string"
],
"imageRef": "string",
"runnerContractVersion": "string",
"paramSchema": {},
"outputSchema": {},
"resourceDefaults": {},
"minGpuMemoryGb": 0,
"recommendedGpuMemoryGb": 0,
"maxGpuCount": 0,
"supportsMultiGpu": true,
"frameworkTags": [
"string"
],
"registryServer": "string",
"registryUsername": "string",
"registryPassword": "string"
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Header parameters
- Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.
Request body
Content-Typeapplication/json
- projectIdstring (uuid) | null
- codestring | null
- namestringrequired
- descriptionstring | null
- imageKindstringrequiredAllowed valuestraininginference
- categorystring | null
- tagsarray<string>
- imageRefstring | null
- runnerContractVersionstring | null
- paramSchemaobject | null
- outputSchemaobject | null
- resourceDefaultsobject | null
- minGpuMemoryGbnumber | null
- recommendedGpuMemoryGbnumber | null
- maxGpuCountnumber | null
- supportsMultiGpuboolean
- frameworkTagsarray<string>
- registryServerstring | null
- registryUsernamestring | null
- registryPasswordstring | null
Responses
Success
- dataobjectrequired
- idstringrequired
- tenantIdstring | nullrequired
- projectIdstring | nullrequired
- codestringrequired
- namestringrequired
- descriptionstring | nullrequired
- imageKindstringrequiredAllowed valuestraininginference
- statusstringrequired
- ownerTypestringrequired
- systemSlugstring | nullrequired
- categorystring | nullrequired
- tagsarray<string>required
- thumbnailUrlstring | nullrequired
- documentationUrlstring | nullrequired
- latestRevisionIdstring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
- modelFamilystring | null
- frameworkstring | null
- frameworkKindstring | nullAllowed valuesofficialconvenience
- isOfficialDefaultone of | null
Response example
{
"data": {
"id": "string",
"tenantId": "string",
"projectId": "string",
"code": "string",
"name": "string",
"description": "string",
"imageKind": "training",
"status": "string",
"ownerType": "string",
"systemSlug": "string",
"category": "string",
"tags": [
"string"
],
"thumbnailUrl": "string",
"documentationUrl": "string",
"latestRevisionId": "string",
"createdAt": "string",
"updatedAt": "string",
"modelFamily": "string",
"framework": "string",
"frameworkKind": "official",
"isOfficialDefault": false
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1