Skip to main content

Jentic SDK for the discovery and execution of APIs and workflows

Project description

Jentic SDK [Beta]

Jentic SDK is a comprehensive library for discovery and execution of APIs and workflows.

The Jentic SDK is backed by the data in the Jentic Public API repository.

Core API & Use Cases

The main entry point is the Jentic class.

Quick Start – search → load → execute

import asyncio
from jentic import Jentic, SearchRequest, LoadRequest, ExecutionRequest

async def main():
    client = Jentic()

    # 1️⃣ find a capability
    results = await client.search(SearchRequest(query="send a Discord DM"))
    entity_id = search.results[0].id  # op_... or wf_...

    # 2️⃣ load details (inspect schemas / auth, see inputs for operations)
    resp = await client.load(LoadRequest(ids=[entity_id]))
    inputs = resp.tool_info[entity_id].inputs

    # 3️⃣ run it
    result = await client.execute(
        ExecutionRequest(id=entity_id, inputs={"recipient_id": "123", "content": "Hello!"})
    )
    print(result)

asyncio.run(main())

LLM Tool Definition & Execution

A typical agent loop with tool use looks like this:

from jentic.lib.agent_runtime import AgentToolManager

manager = AgentToolManager(format="anthropic")
llm_tools = manager.generate_tool_definitions()  # pass to your LLM

# --- within your agent loop ---
while response.stop_reason == "tool_use":
    tool_call = next(b for b in response.content if b.type == "tool_use")
    name      = tool_call.name
    inputs    = tool_call.input

    result = await manager.execute_tool(name, inputs)
    # ... handle result ...

Components

agent_runtime

A library for generating, managing, and executing LLM-compatible tools from Arazzo workflows and OpenAPI operations.

Features:

  • Generate dynamic tool definitions for OpenAI and Anthropic LLMs from project workflows and API operations
  • Execute workflows and operations as tools via a unified interface
  • Provide runtime classes for tool management (AgentToolManager), tool specification (LLMToolSpecManager), and execution (TaskExecutor)
  • Return standardized results for workflow and operation execution

api

A client for the Jentic API Knowledge Hub.

Set JENTIC_API_URL to set the base URL for the API hub client for local testing or testing against the development environment.

Installation

For Development

To install the package in development mode:

# From the current directory
pip install -e .

Then you can import it in your projects:

import jentic

You can also import it to other projects by referencing the package directory by specifying the following in your pyproject.toml:

dependencies = [
    "jentic @ file:///path/to/jentic/sdk"
]

For Production

pip install jentic

API Key

See the root README for instructions on creating an agent and exporting your JENTIC_AGENT_API_KEY. Remember to set it in the environment before running any examples.

Testing

# Run unit tests for jentic
pdm run test

# Run integration tests for dev environment
pdm run integration-dev

# Run integration tests for production environment
pdm run integration

Integration Test Configuration

Integration tests require environment variables to be set in environment-specific files. An example file is provided that you need to copy and configure:

# For development testing
cp tests/integration/.env.example tests/integration/.env.dev

# For production testing
cp tests/integration/.env.example tests/integration/.env.prod

After copying, edit these files to include your API credentials and configuration:

  1. For development testing: tests/integration/.env.dev
  2. For production testing: tests/integration/.env.prod

Example configuration:

# Required UUIDs for Discord API testing
DISCORD_GET_MY_USER_OPERATION_UUID="your_operation_uuid_here"
DISCORD_GET_USER_DETAILS_WORKFLOW_UUID="your_workflow_uuid_here"

# Base URL for Jentic API (Uncomment for Dev)
JENTIC_API_URL=https://directory-api.qa1.eu-west-1.jenticdev.net

# Your Discord bot token
DISCORD_BOTTOKEN="your_bot_token_here"

The integration tests validate:

  1. Loading operation and workflow execution information
  2. Executing Discord operations and workflows
  3. Searching API capabilities
  4. Generating LLM tool definitions
  5. Running LLM tools including both operations and workflows

Linting & Formatting

# Run all linting for jentic
pdm run lint

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jentic-0.9.4.tar.gz (49.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jentic-0.9.4-py3-none-any.whl (36.1 kB view details)

Uploaded Python 3

File details

Details for the file jentic-0.9.4.tar.gz.

File metadata

  • Download URL: jentic-0.9.4.tar.gz
  • Upload date:
  • Size: 49.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jentic-0.9.4.tar.gz
Algorithm Hash digest
SHA256 2ab3640b84055f016828b8b53e66685b12619d9ceb3ab2da717c4580c936873d
MD5 d4de431a980a733ef5073958a5d2acba
BLAKE2b-256 e4efd2e2f39dad9dbc33d69e7cbaef35f909183e641b403d319e5c3e4fe0b382

See more details on using hashes here.

Provenance

The following attestation bundles were made for jentic-0.9.4.tar.gz:

Publisher: jentic-sdk-pypi.yaml on jentic/jentic-sdks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jentic-0.9.4-py3-none-any.whl.

File metadata

  • Download URL: jentic-0.9.4-py3-none-any.whl
  • Upload date:
  • Size: 36.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jentic-0.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1616c179b559a8ed2c00cb8f4e51163696f78173ef67eb3c642c4ef50c88d438
MD5 4d005ecf465c08dcf071d7f7395a51a1
BLAKE2b-256 24b5a3039b0c4a8fe8b19a7e922df9902d6ea9c1b079a794090f86358d76281e

See more details on using hashes here.

Provenance

The following attestation bundles were made for jentic-0.9.4-py3-none-any.whl:

Publisher: jentic-sdk-pypi.yaml on jentic/jentic-sdks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page