General

Method	Description
raw_request	Sends raw requests directly to the Jinko API, with only auth headers added.
auth_check	Validate credentials and the key's declared scope for this project.
set_timeout	Sets the timeout limit used for each request sent to the Jinko API.

raw_request

raw_request(
    method: str,
    path: str,
    *,
    params: dict[str, Any] | None = None,
    json_body: Any | None = None,
    data: bytes | None = None,
    headers: dict[str, str] | None = None,
    accept: str | None = None,
    content_type: str | None = None
) -> Any

Sends raw requests directly to the Jinko API, with only auth headers added.

auth_check

auth_check() -> AuthCheckResult

Validate credentials and the key's declared scope for this project.

A key limited to one or several projects must include this project's ID in its declared scope. An AllProjects key has no fixed project list. This check does not establish that the project exists or that the key owner has access to it. Request a project resource to verify access.

Session credentials without API key metadata receive a credential check only.

Returns:

• AuthCheckResult: An AuthCheckResult with the authentication status and API key
• AuthCheckResult: metadata reported by the API.

Raises:

• AuthenticationError: Credentials are invalid or this project is outside the key's declared scope.

set_timeout

set_timeout(value: float | int | None)

Sets the timeout limit used for each request sent to the Jinko API.