Reference
Exact commands, methods, and flags. Pick the surface that matches who is calling.
Three surfaces reach the same platform; they differ in who calls them.
| Surface | Who calls it | Use it to |
|---|---|---|
| CLI | You, or your coding agent, signed in as you | Build and run recipes locally, deploy runtimes, configure bindings and credentials, read production evidence, run evals, calibrate judges, and run experiments. |
| SDKs (JavaScript, Python, Rust, Swift) | Your application, with an API key or a user session | Run tasks against a deployed runtime, stream results, attach files, read conversations, events, and metrics, and record user feedback. |
| REST API | Any HTTP client | Everything above, when no SDK fits your language. |
Which to use when
- You are building or improving an agent. Use the CLI, yourself or through a coding agent.
- Your product calls an agent. Use an SDK in your backend or browser app. See Run tasks from your backend for the full integration and Authentication for the credential your code holds.
- You are scripting operations (CI, a smoke test, a one-off export). Use
the CLI with JSON output and
--query. - No SDK fits. Call the REST API directly.
The SDKs do not author recipes or administer projects: runtimes, bindings,
credentials, and judges are managed with the CLI or the dashboard. An SDK can
read a runtime and run it, and client.experiments can create, update,
delete, start, end, and cancel experiments.
SDK packages
| Language | Package |
|---|---|
| JavaScript (Node.js) | @introspection-sdk/introspection-node |
| JavaScript (browser) | @introspection-sdk/introspection-browser |
| Python | introspection-sdk |
| Rust | introspection-sdk |
| Swift | IntrospectionSDK from https://github.com/introspection-org/introspection-swift-sdk (Swift Package Manager) |
The server-side SDKs read INTROSPECTION_TOKEN from the environment; the browser SDK takes the token you pass it.
While introspection dev is running, an application on the
Node.js SDK reaches your local recipe through its normal calls when it sets
INTROSPECTION_DEV_TARGET.
More reference
- Task operations: statuses, interrupts, cancellation, and diagnosing a task.
- Concepts: the terms used across these docs.
- Limits: every fixed number.
Last updated on