Update API key label

Updates descriptive metadata for an API key without changing the credential or its project scope.

PATCH

https://api.novaai.com/v1/api-keys/{api_key_id}

Authentication

Send a project-scoped NovaAI API key in the Authorization header using the Bearer scheme. Requests without valid credentials return 401 Unauthorized.

Authorization

string

required

Request properties

api_key_id

string

required

Identifier of the API key to update.

name

string

required

New label used in the Developer Dashboard and audit logs.

expires_at

string

optional

Updated optional expiration time.

Response behavior

A successful PATCH request returns a structured NovaAI resource response. Validate the returned identifier before persisting it, and handle 400 Bad Request for malformed input or 401 Unauthorized for invalid project credentials.

Integration notes

Use PATCH /v1/api-keys/{api_key_id} from a trusted server environment. Keep your NovaAI API key out of browser bundles and pass only the data required for update api key label in each request.

Validate inputs before sending the request, log the returned request identifier for troubleshooting, and use exponential backoff for temporary failures or rate-limit responses. Treat malformed payloads and authorization failures as non-retryable until corrected.

Error handling

Inspect the error type and code returned by NovaAI before retrying. Correct invalid parameters for 400 responses, refresh or replace credentials for 401 responses, and wait before retrying requests that are temporarily limited.

PATCH/v1/api-keys/{api_key_id}

PATCH /v1/api-keys/{api_key_id} HTTP/1.1
Authorization: Bearer NOVA_API_KEY
Content-Type: application/json

200Success response

{
  "id": "update_api_key_label_01",
  "object": "nova.resource",
  "status": "succeeded"
}

400Invalid request

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error",
    "code": "invalid_parameter"
  }
}

Update API key label

Last updated: Aug 14, 2026

PATCH/v1/api-keys/{api_key_id}

PATCH /v1/api-keys/{api_key_id} HTTP/1.1
Authorization: Bearer NOVA_API_KEY
Content-Type: application/json

200Success response

{
  "id": "update_api_key_label_01",
  "object": "nova.resource",
  "status": "succeeded"
}

400Invalid request

{
  "error": {
    "message": "Invalid request",
    "type": "invalid_request_error",
    "code": "invalid_parameter"
  }
}

Get Template