provod.ai / docs
API

Update an API key

Update an inference key’s name, spending limit, expiration or access state.

Last updated on

PATCH /v1/keys/{hash}

Change a key’s name, access state, expiration or spending limit. Omitted fields keep their current values.

Authentication

Authorization: Bearer <MANAGEMENT_API_KEY>: a management key bound to the workspace. The key owner must retain the live permission apiKeys.create.

The credential determines the workspace. X-Org-Id is unsupported.

Path parameters

FieldTypeDescription
hashstring · requiredSHA-256 digest from data.hash on creation or listing. Not the secret or internal key ID.

Request body

Content-Type: application/json

FieldTypeDescription
namestring1–80 characters after trimming. Required on creation; optional on update.
limitnumber | null0–9999999999.99, up to 8 decimal places. null removes the cap; zero blocks new paid admissions.
limit_resetstring | nulldaily, weekly, monthly, or null (lifetime). Calendar windows use UTC. A non-null reset requires a limit.
disabledbooleanDefault false on creation. true blocks new requests, false re-enables the key.
expires_atstring | nullISO UTC date-time, for example 2030-01-01T00:00:00Z. null removes expiration.
workspace_idstringOptional nonempty assertion of the current workspace; cannot switch workspaces.
include_byok_in_limitfalseOnly false is accepted. BYOK is unavailable.

Unknown fields are rejected. On creation, omitted limit means no cap, omitted limit_reset means lifetime, and omitted expires_at means no expiration.

Send at least one field. Keys with multiple cabinet limits must have limit or limit_reset changed in the cabinet. New limits include historical spending in the window. Disabling does not cancel accepted requests or their settlement.

Response · 200

FieldTypeDescription
dataobjectKey object.

Each key includes the current-key fields plus:

FieldTypeDescription
hashstringSHA-256 locator used in the path.
namestringKey name.
disabledbooleanWhether new inference requests are blocked.
created_atstring (date-time)Creation timestamp.
updated_at, last_used_atstring | nullISO timestamps or null when unavailable.

With multiple limits, limit, limit_reset and limit_remaining are null; read spend_limits. is_management_key is always false.

Response example

Identifiers and amounts in these examples are illustrative.

Request example

Load the key into a server environment variable. TypeScript uses Node.js fetch; Python uses only the standard library.

Replace the example hash with your key’s data.hash.

const response = await fetch("https://api.provod.ai/v1/keys/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MANAGEMENT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "disabled": true
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());

Errors

HTTPErrorCause
401UnauthorizedMissing, invalid, disabled, revoked or expired key. The X-Org-Id header is also rejected.
403ForbiddenWrong key kind or insufficient workspace access.
400Bad RequestInvalid or unknown parameters.
404Not FoundKey not found, revoked or outside the workspace.

Authentication error example:

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key",
    "metadata": {}
  }
}

Operation error example:

{
  "message": "API key not found",
  "error": "Not Found",
  "statusCode": 404
}

Next steps

On this page