API reference · Model references
Delete a model reference nothing mounts
DELETE
/v1/model-references/{reference_id}API keymodel_reference:deleteProject
- TypeScript
client.modelReferences.delete()- Python
client.model_references.delete()- CLI
hayonix model-references delete
Deletes a model reference. Refused (409) while a workload mounts it or a serverless endpoint’s current release names it. Hosts drop its files as their caches need the room.
Project API key (Authorization: Bearer sk_…), or a console session. Requires the model_reference:delete permission (a key's scope, or a role that includes it).
Examples
The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.
curl -sS -X DELETE "$API_BASE_URL/model-references/mrf_01jc5zq4m8k3v6x9t2w7r0b1e4" \
-H "Authorization: Bearer $API_KEY"Request
| Header | Required | Description |
|---|---|---|
Authorization | yes | Bearer and your API key. The key implies its project. |
X-Project-Id | session only | The project to act in, for console sessions. Requests with an API key leave it out. |
Path parameters
reference_idstringrequiredID of the reference
ID with prefix mrf_
Response
200 DeletedModelReference — Deleted
objectstringrequiredAlways `model_reference`: the type of this object
One of
model_referenceidstringrequiredUnique ID
deletedbooleanrequiredAlways true
One of
true
Example response
Example response
{
"object": "model_reference",
"id": "string",
"deleted": true
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
400 | invalid_request_error | A parameter or body field is missing or not allowed; param names it. |
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
404 | not_found_error | No such resource in this project (an ID from another project is answered the same way). |
409 | conflict_error | The resource's current state does not allow this. |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |