Skip to main content

SDK and skills

The jinko-sdk package is the typed Python interface to Jinkō. Jinkō Skills add reusable procedures that agents can follow from external harnesses such as coding agents and scientific workbenches.

Install the SDK and skills

pip install jinko-sdk
npx skills add novainsilico/jinko-skills

Use the SDK when you need direct control from Python. Use a skill when you want an agent to follow a repeatable workflow with explicit inputs, checks, outputs, and review points.

Create API credentials

1. Open project settings

  1. Select the settings icon beside the project name.
  2. Select the API access tab.

The API access tab in Jinkō project settings

2. Create a key

  1. Select Add API key.
  2. Name the key, then select Create.
  3. Copy the secret. Jinkō displays it once.

The form for creating a Jinkō API key

3. Test the connection

Send a request to the authentication endpoint with your API key and project ID:

curl --request GET \
--url https://api.jinko.ai/app/v1/auth/check \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'X-jinko-project-id: YOUR_JINKO_PROJECT_ID'

A valid key returns:

{
"status": "authenticated"
}

See the authentication operation for the complete REST reference.

Continue