openai/openai-python · error · ValueError

Expected a non-empty value for `key_id` but received {key_id

Error message

Expected a non-empty value for `key_id` but received {key_id!r}

What it means

The sync Admin APIKeys `retrieve` method requires a non-empty `key_id` path parameter; passing an empty string or None means the URL /organization/admin_api_keys/{key_id} cannot be formed, so the SDK raises ValueError before any HTTP request.

Source

Thrown at src/openai/resources/admin/organization/admin_api_keys.py:118

        extra_body: Body | None = None,
        timeout: float | httpx2.Timeout | None | NotGiven = not_given,
    ) -> AdminAPIKey:
        """
        Retrieve a single organization API key

        Args:
          key_id: The ID of the API key.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        if not key_id:
            raise ValueError(f"Expected a non-empty value for `key_id` but received {key_id!r}")
        return self._get(
            path_template("/organization/admin_api_keys/{key_id}", key_id=key_id),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                security={"admin_api_key_auth": True},
            ),
            cast_to=AdminAPIKey,
        )

    def list(
        self,
        *,
        after: Optional[str] | Omit = omit,
        limit: int | Omit = omit,
        order: Literal["asc", "desc"] | Omit = omit,

View on GitHub (pinned to 9917c6e28e)

Solutions

  1. Ensure the key_id is set before calling retrieve (fetch it from create/list first)
  2. Add an upstream check/guard for empty IDs when looping over data

Example fix

# before
client.admin.api_keys.retrieve(key_id)
# after
if not key_id:
    raise ValueError('missing key_id')
client.admin.api_keys.retrieve(key_id)
Defensive patterns

Strategy: validation

Validate before calling

if not key_id:
    raise ValueError('key_id is required')
client.admin.api_keys.retrieve(key_id)

Type guard

def is_nonempty_id(v: object) -> bool:
    return isinstance(v, str) and bool(v.strip())

Prevention

When it happens

Trigger: client.admin.api_keys.retrieve('') or retrieve(None), typically because an ID variable failed to populate (empty DB field, missed parsing step).

Common situations: Iterating records where some lack a key id, or an upstream API response shape change leaving key_id empty.

Related errors

AI-assisted analysis of openai/openai-python@9917c6e28e (2026-08-28). Data as JSON: /api/errors/f090ef6f7653352c. Report an issue: GitHub.