# Troubleshooting

Work through the entry that matches your symptom — each one gives a quick
check and the fix.

## The SDK cannot connect

Check that the hosted API is reachable:

```bash
curl https://api.instantml.ai/healthz
```

If the health check succeeds, confirm your SDK key is configured:

```bash
test -n "$INSTANTML_API_KEY" && echo "INSTANTML_API_KEY is set"
```

Fix: run `instantml login`, export `INSTANTML_API_KEY`, or pass
`api_key="instantml_..."` directly to `im.init(...)`.

## Hosted calls are unauthorized

Check that an API key is present in the environment:

```bash
test -n "$INSTANTML_API_KEY" && echo "INSTANTML_API_KEY is set"
```

Fix: run `instantml login`, set `INSTANTML_API_KEY`, or pass
`api_key="instantml_..."` directly to `im.init(...)`.

## Hosted calls are rate-limited

Check the `X-InstantML-RateLimit-Scope` header on the `429` response to see
which limit you hit.

Fix for `second` scope: retry after the `Retry-After` header delay or reduce
request concurrency.

Fix for `monthly` scope: the quota resets at the next UTC calendar month. Free
and non-billable workspaces are blocked at the monthly allowance, while paid
Pro and Premium API request overage is Stripe-metered. See
[Pricing, limits, and billing](/docs/guides/pricing-limits-billing.md).

## The dashboard does not show my run

Check the project name you used in the SDK call. `project="cartpole"` appears
in the dashboard project selector as `cartpole`.

Fix: if the run was created but later logging calls failed, call `run.flush()`
when using buffering and check SDK exceptions for the failed request.

## Offline replay did not create a run

Check whether the failure happened during `init()` itself. Current limitation:
`init()` still needs a reachable server because run creation is not spooled
yet.

Fix: none needed for later calls — `offline_dir` covers failed requests made
after a run already exists. Retry `init()` once the server is reachable.

## Neptune imports fail before parsing

Check that `pyarrow` is installed and the input path is right.

Fix: install the import extras with `pip install "instantml[imports]"` and
point the importer at the exported Parquet directory rather than a symlink.
For the full import workflow and CLI flags, see [Imports](/docs/guides/imports.md).

## TensorBoard sync produces no new points

Check that the run source identity matches the original imported TensorBoard
run and that the event files contain scalar summaries.

Fix: re-run the sync against the original run's source identity, or confirm
the event files actually log scalars. See [Imports](/docs/guides/imports.md) for the
sync workflow.

## Generated API reference looks stale

The generated reference should match the practical API guides.

Fix: if a documented hosted route is missing, report the page URL, endpoint,
and response `x-request-id` if a request failed.

## Next steps

- [Pricing, limits, and billing](/docs/guides/pricing-limits-billing.md)
- [SDK reliability](/docs/sdk/reliability.md)
- [Imports](/docs/guides/imports.md)
- [Errors, pagination, and limits](/docs/api/errors-and-limits.md)

## Agent navigation

- [Docs index](/llms.txt)
- [Full docs bundle](/llms-full.txt)

### Get Started

- [Overview](/docs/index.md)
- [Quickstart](/docs/quickstart.md)
- [Core Concepts](/docs/concepts/core-concepts.md)
- [Pricing](/docs/pricing.md)
- [Benchmarks](/docs/benchmarks.md)
- [Examples](/docs/guides/examples.md)
- [Troubleshooting](/docs/troubleshooting.md) (current page)

### SDK

- [Installation Auth](/docs/sdk/installation-auth.md)
- [Logging](/docs/sdk/logging.md)
- [Tracing](/docs/sdk/tracing.md)
- [Metrics Steps](/docs/sdk/metrics-steps.md)
- [Config Tags Notes](/docs/sdk/config-tags-notes.md)
- [Artifacts Checkpoints](/docs/sdk/artifacts-checkpoints.md)
- [Rich Objects](/docs/sdk/rich-objects.md)
- [Distributed Training](/docs/sdk/distributed-training.md)
- [Console System Integrations](/docs/sdk/console-system-integrations.md)
- [Reliability](/docs/sdk/reliability.md)
- [Cli Login](/docs/sdk/cli-login.md)
- [Querying Data](/docs/sdk/querying-data.md)
- [Agent Mcp](/docs/sdk/agent-mcp.md)
- [Examples Patterns](/docs/sdk/examples-patterns.md)

### Integrations

- [Overview](/docs/integrations/overview.md)
- [Pytorch Lightning](/docs/integrations/pytorch-lightning.md)
- [Huggingface Transformers](/docs/integrations/huggingface-transformers.md)
- [Keras](/docs/integrations/keras.md)
- [Wandb](/docs/integrations/wandb.md)

### Dashboard

- [Tour](/docs/dashboard/tour.md)
- [Organizations Workspaces](/docs/dashboard/organizations-workspaces.md)
- [Runs Workspace](/docs/dashboard/runs-workspace.md)
- [Metrics Charts](/docs/dashboard/metrics-charts.md)
- [Run Detail](/docs/dashboard/run-detail.md)
- [Traces](/docs/dashboard/traces.md)
- [Compare Runs](/docs/dashboard/compare-runs.md)
- [Research Dashboards](/docs/dashboard/research-dashboards.md)
- [Artifacts Files](/docs/dashboard/artifacts-files.md)
- [Run Health](/docs/dashboard/alerts.md)
- [Datasets](/docs/dashboard/datasets.md)
- [Checkpoints](/docs/dashboard/checkpoints.md)
- [Reports](/docs/dashboard/reports.md)
- [Settings Api Keys](/docs/dashboard/settings-api-keys.md)
- [Api Tab](/docs/dashboard/api-tab.md)
- [Onboarding Team Billing](/docs/dashboard/onboarding-team-billing.md)

### Data

- [Imports](/docs/guides/imports.md)
- [W&B alternative](/docs/guides/wandb-alternative.md)
- [InstantML vs MLflow](/docs/guides/instantml-vs-mlflow.md)
- [W&B import guide](/docs/guides/wandb-import-guide.md)
- [W&B and Neptune imports](/docs/guides/wandb-neptune-imports.md)
- [Export Usage Limits](/docs/guides/export-usage-limits.md)
- [Pricing Limits Billing](/docs/guides/pricing-limits-billing.md)
- [Auth Billing Storage](/docs/guides/auth-billing-storage.md)
- [Customer Owned Clickhouse](/docs/guides/customer-owned-clickhouse.md)
- [Observability](/docs/guides/observability.md)

### API

**Practical API guides**

- [Authentication](/docs/api/authentication.md)
- [Errors And Limits](/docs/api/errors-and-limits.md)
- [Health Observability](/docs/api/health-observability.md)
- [Projects Runs](/docs/api/projects-runs.md)
- [Metrics Series](/docs/api/metrics-series.md)
- [Attributes Objects](/docs/api/attributes-objects.md)
- [Artifacts](/docs/api/artifacts.md)
- [Reports](/docs/api/reports.md)
- [Iframe Embeds](/docs/api/iframe-embeds.md)
- [Import Export Usage](/docs/api/import-export-usage.md)
- [Dashboard Control State](/docs/api/dashboard-control-state.md)
**Architecture**

- [System Overview](/docs/architecture/system-overview.md)
- [Service Planes](/docs/architecture/service-planes.md)
- [Storage Model](/docs/architecture/storage-model.md)
- [Google Clickhouse](/docs/architecture/google-clickhouse.md)
- [Auth Tenancy](/docs/architecture/auth-tenancy.md)
- [Schema Reference](/docs/architecture/schema-reference.md)

### API Reference

- [API Reference](/docs/api-reference.md)
