Skip to main content
The AiQL SDKs are typed wrappers around the AiQL API and React components for embedding AiQL tools. The HTTP clients handle authentication, request building, and response parsing. The React SDK embeds Canvas and Dashboard via iframe without exposing your API key to the browser.

​
Available SDKs

Python

Install with pip and call the API from any Python 3.10+ application.

TypeScript

Install with npm (@aiql.io/sdk) and use in Node.js or the browser with full type safety.

React

Embed Canvas and Dashboard in your React app with @aiql.io/react.

​
What the HTTP SDKs cover

The Python and TypeScript SDKs expose the same resources:
  • Workspaces — create, read, update, and delete workspaces.
  • Ingestions — start ingestions, check status, cancel, and retry.
  • Queries — run queries and fetch results.
  • Sources — inspect ingested documents, chunks, pages, and knowledge graphs.
  • Canvases / Dashboards — manage brainstorm canvases and dashboards.
  • Requests — source addition/removal requests, reviews, and comments.
  • Tools — convert, split, shape, and extract.

​
What the React SDK covers

The React SDK embeds AiQL Observatory tools in your product:
  • Canvas — Brainstorm canvas editor in an iframe.
  • Dashboard — Analyze dashboard in an iframe.
  • Server helpers — one-line Next.js or Express routes that mint embed tokens.
See the React SDK overview for install and wiring.

​
Authentication

Every HTTP SDK is configured with an API key. Generate one in the Dashboard and provide it when you create the client. Keep your key in an environment variable rather than committing it to source control. The React SDK keeps the API key on your server. The browser only receives a short-lived embed token.
The HTTP SDKs default to the production API at https://api.aiql.io. Override the base URL to point at a local or staging server.