# Attributes and objects API

Store typed non-scalar context as attributes, and log first-class table, media,
histogram, and evaluation payloads as rich objects for Run Detail and
artifact-style inspection.

Authenticate with an `Authorization: Bearer instantml_...` API key or a browser
session. Writes on this page need the `sdk:ingest` scope; reads need
`export:read`.

## Write attributes

Batch form:

```bash
curl -X POST https://api.instantml.ai/api/runs/{run_id}/attributes \
  -H "Authorization: Bearer instantml_..." \
  -H "Content-Type: application/json" \
  -d '{
    "attributes": [
      {
        "path": "config/optimizer",
        "type": "string_series",
        "step": 1,
        "timestamp": "2026-05-16T00:00:00Z",
        "value": "adam",
        "summary": {},
        "artifact_id": null
      }
    ]
  }'
```

Requires `sdk:ingest` or a writable browser session. Single-attribute form can
put `path`, `type`, `step`, `timestamp`, `value`, and `summary` at the top
level.

Use rich object endpoints for tables, media, logged histograms, and typed
evaluation bundles.

## List attributes

```http
GET /api/runs/{run_id}/attributes?type=string_series&path_prefix=config/&limit=100
Authorization: Bearer instantml_...
```

Requires `export:read`. Filters:

| Parameter | Meaning |
| --- | --- |
| `type` | Optional attribute type. |
| `path_prefix` | Optional path prefix. |
| `limit` | Max 5,000. |
| `offset` | Offset pagination. |

## Create a rich object

```http
POST /api/runs/{run_id}/objects
Authorization: Bearer instantml_...
Content-Type: application/json

{
  "key": "eval/samples",
  "kind": "table",
  "step": 1,
  "artifact_id": null,
  "metadata": {},
  "summary": { "columns": ["prompt", "score"] },
  "value": { "kind": "table" },
  "rows": [
    { "prompt": "hello", "score": 0.92 }
  ]
}
```

Requires `sdk:ingest` or a writable browser session. Supported kinds:

- `table`
- `image`
- `video`
- `audio`
- `histogram`
- `classification_eval`

Media objects require an artifact ID from the same run. Tables accept up to
1,000 rows per create request. Histogram objects require finite bins and
nonnegative counts with compatible lengths. `classification_eval` objects are
compact binary classification bundles with PR/ROC curves, a confusion matrix,
per-class metrics, and optional prediction preview rows.

## List rich objects

```http
GET /api/runs/{run_id}/objects?kind=table&limit=100&offset=0
Authorization: Bearer instantml_...
```

Requires `export:read`. The response includes object envelopes with inline
values for non-table rich objects. Table row contents are paged separately
through the rows endpoint.

Use `kind=histogram&key=...&limit=100` to read selected-run logged histogram
frames for Runs workspace timeline panels. The current API reads one run and
one explicit object key; multi-run histogram timelines need a separate bounded
endpoint.

## Page table rows

```http
GET /api/objects/{object_id}/rows?limit=100&offset=0
Authorization: Bearer instantml_...
```

Requires `export:read`. Response:

```json
{
  "object_id": 123,
  "rows": [
    {
      "row_index": 0,
      "row": { "prompt": "hello", "score": 0.92 },
      "created_at": "2026-05-16T00:00:00Z"
    }
  ],
  "limit": 100,
  "offset": 0
}
```

Table row reads default to 100 rows and cap at 1,000 rows.

## Next steps

- [Log rich objects from the SDK](/docs/sdk/rich-objects.md)
- [Attach artifacts to runs](/docs/api/artifacts.md)
- [Inspect objects in Run Detail](/docs/dashboard/run-detail.md)
- [Handle 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)

### 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) (current page)
- [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)
