Skip to content
Docs
Follow yggy on LinkedInFollow @yggy_tech on X

SDKs

The yggy SDKs are typed clients for the REST API. They cover the same operations as the public API and the CLI, and they send the same API keys.

TypeScript and JavaScript Node.js 18+ and the browser, built on fetch.
Python Python 3.9 or newer, with typed models.
Go Go 1.23 or newer, context-aware calls.
Rust Async client on reqwest. File upload is coming soon.

Install status

Section titled “Install status”

All four SDKs are open source under Apache-2.0. They are not on the package registries yet, so you install the v0.1.0 tag from GitHub for now. Pin the tag, because main changes whenever the API does.

LanguageRepositoryPackageRegistry release
TypeScriptyggy-sdk-js@yggy-tech/sdkComing soon
Pythonyggy-sdk-pythonyggyComing soon
Goyggy-sdk-gogithub.com/yggy-tech/yggy-sdk-goComing soon
Rustyggy-sdk-rustyggy-sdkComing soon

v0.1.0 is the first release. Expect changes before a stable 1.0.

What you can call

Section titled “What you can call”
  • Projects: list and create.
  • Documents: upload, list, read, status, extracted facts, download, retry, re-extract and delete.
  • Questions over one project or the whole organization, and chat.
  • Entity lookup by identity, the ontology overview and graph exports.

The Reference lists every operation with its parameters. Operation names in the SDKs follow the operation ids in the Reference, adapted to each language’s naming style, for example listProjects, list_projects and ListProjects.

Which one should I use?

Section titled “Which one should I use?”
  • Use an SDK when you build a service or an app and want typed requests and responses.
  • Use the CLI for shell scripts, CI jobs and quick checks from your terminal.
  • Use the REST API directly from any other language. Everything an SDK does is a plain HTTP call.
  • Use MCP to give an AI client access to your graph.

Generated code

Section titled “Generated code”

The SDKs are generated from the yggy OpenAPI document and updated whenever the public API changes, so they stay in step with the Reference. Do not edit the generated code by hand, because the next update overwrites it. To report a bug or ask for an operation, open an issue in the language’s repository or write to support.