Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions api-reference/add-media-to-existing-dataset.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
---

<Card title="How This Helps" icon="hand-platter">
Incrementally add new media (images or videos) to an already-indexed dataset without re-processing everything from scratch. New media is processed as an independent batch and becomes immediately visible. When ready, trigger a full reindex to re-cluster the entire dataset.

Check warning on line 7 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L7

Did you really mean 'reindex'?
</Card>

<Note>
Expand Down Expand Up @@ -50,7 +50,7 @@

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `auto_reindex` | boolean | `false` | Automatically run a full reindex after the partial update completes |

Check warning on line 53 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L53

Did you really mean 'reindex'?
| `assume_role` | string | `null` | AWS IAM role ARN to assume for cross-account S3 access |
| `batch_n_videos` | integer | `null` | Override auto-calculated video count (for resource allocation) |
| `batch_n_images` | integer | `null` | Override auto-calculated image count (for resource allocation) |
Expand Down Expand Up @@ -146,7 +146,7 @@
https://app.visual-layer.com/api/v1/dataset/<dataset_id>/add_media
```

This runs a combined workflow: **partial update** (process new media) followed by **reindex** (re-cluster everything). The dataset returns to `READY` when complete.

Check warning on line 149 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L149

Did you really mean 'reindex'?

<Tip>
Use `auto_reindex=true` when you want a single API call to handle everything. Omit it if you plan to add multiple batches before re-clustering.
Expand All @@ -154,9 +154,9 @@

---

## Manual Reindex

Check warning on line 157 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L157

Did you really mean 'Reindex'?

If you added media without `auto_reindex`, the dataset enters `PARTIAL INDEX` status. You can trigger a manual reindex when ready:

Check warning on line 159 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L159

Did you really mean 'reindex'?

```bash
curl -X POST \
Expand All @@ -167,7 +167,7 @@
**Response:** `HTTP 202 Accepted`

<Note>
The reindex endpoint only accepts datasets in `PARTIAL INDEX` status. If the dataset is still processing (`READ ONLY`), wait for it to finish before triggering reindex.

Check warning on line 170 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L170

Did you really mean 'reindex'?

Check warning on line 170 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L170

Did you really mean 'reindex'?
</Note>

---
Expand Down Expand Up @@ -279,14 +279,14 @@
| **400** | Bad Request | Invalid request parameters | Missing embedding config, invalid S3 URI, no media source provided, or multiple media sources in one request |
| **403** | Forbidden | Feature disabled or insufficient permissions | `ADD_MEDIA_ENABLED` is false, or user lacks write access to the dataset |
| **404** | Not Found | Dataset not found | Dataset does not exist, or the authenticated user does not have access to it |
| **409** | Conflict | Dataset state incompatible | Dataset status is not `READY` or `PARTIAL INDEX`, or another add media / reindex operation is already running |

Check warning on line 282 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L282

Did you really mean 'reindex'?
| **500** | Internal Server Error | Server-side failure | File upload to S3 failed, or pipeline trigger failed |

### Reindex (`POST /api/v1/dataset/{dataset_id}/reindex`)

Check warning on line 285 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L285

Did you really mean 'Reindex'?

| HTTP Code | Status | Meaning | Common Cause |
|-----------|--------|---------|--------------|
| **202** | Accepted | Reindex started successfully | Request valid, reindex pipeline triggered |

Check warning on line 289 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L289

Did you really mean 'Reindex'?

Check warning on line 289 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L289

Did you really mean 'reindex'?
| **404** | Not Found | Dataset not found | Dataset does not exist or user lacks access |
| **409** | Conflict | Dataset state incompatible | Dataset status is not `PARTIAL INDEX` |
| **500** | Internal Server Error | Server-side failure | Pipeline trigger failed |
Expand Down Expand Up @@ -331,14 +331,14 @@
|-------|--------------|
| Before | `READY` |
| Processing | `READ ONLY` |
| Awaiting Reindex | `PARTIAL INDEX` |

Check warning on line 334 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L334

Did you really mean 'Reindex'?
| Reindexing | `READ ONLY` → `INDEXING` |

Check warning on line 335 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L335

Did you really mean 'Reindexing'?
| Complete | `READY` |

For a description of each status value, see [Retrieve Dataset Status](/api-reference/retrieve-dataset-status).

<Tip>
With `auto_reindex=true`, the flow goes directly from `UPDATING` through reindexing back to `READY` without stopping at `PARTIAL INDEX`.

Check warning on line 341 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L341

Did you really mean 'reindexing'?
</Tip>

---
Expand All @@ -365,5 +365,24 @@
```

<Note>
On-premises add media uses local file paths instead of S3 URIs. The `path` parameter must be an absolute path accessible from the pipeline container.

Check warning on line 368 in api-reference/add-media-to-existing-dataset.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/add-media-to-existing-dataset.mdx#L368

Did you really mean 'URIs'?
</Note>

---

## Related Resources

<CardGroup cols={2}>
<Card title="Saved Views API" icon="file-code-2" href="/api-reference/saved-views">
Create monitored views that automatically evaluate new media as it arrives.
</Card>
<Card title="Notifications API" icon="file-code-2" href="/api-reference/notifications">
Retrieve alerts generated when new media matches saved view filters.
</Card>
<Card title="Monitoring and Alerts" icon="blend" href="/docs/advanced-features/notifications">
Understand how adding media triggers monitoring evaluation and alert delivery.
</Card>
<Card title="Task Manager API" icon="list-checks" href="/api-reference/task-manager">
Track add media and reindex tasks programmatically.
</Card>
</CardGroup>
2 changes: 1 addition & 1 deletion api-reference/enrichment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@

---

## Check Applied Enrichments

Check warning on line 90 in api-reference/enrichment.mdx

View check run for this annotation

Mintlify / Mintlify Validation (visual-layer) - vale-spellcheck

api-reference/enrichment.mdx#L90

Did you really mean 'Enrichments'?

Retrieve the enrichment configuration currently applied to a dataset.

Expand Down Expand Up @@ -164,7 +164,7 @@
}
```

The response returns the `dataset_id` of the **new enriched copy**. Poll this new dataset's status endpoint until `status_new` reaches `READY` before running search or export operations on it.
The response returns the `dataset_id` of the **new enriched copy**. Poll the status endpoint for this new dataset until `status_new` reaches `READY` before running search or export operations on it.

<Note>
The source dataset enters `READ ONLY` status while enrichment runs. The enriched copy is a separate dataset — it has its own `dataset_id` and appears as a new entry in your dataset inventory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Export dataset metadata and media using the Visual Layer API—supp
---

<Card title="How This Helps" icon="hand-platter">
Export your dataset's metadata, labels, and media files for use in training pipelines, annotation tools, or downstream analysis. Both full and selective exports are supported.
Export your dataset metadata, labels, and media files for use in training pipelines, annotation tools, or downstream analysis. Both full and selective exports are supported.
</Card>

## Prerequisites
Expand Down
Loading