Skip to content

my changes #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

my changes #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 8 additions & 7 deletions api-reference/create-a-dataset-from-a-public-s3-bucket.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Create a Dataset from an S3 Bucket
description: Create a new Visual Layer dataset by pointing to a public or private S3 bucket using the cloud API.
title: "Create a Dataset "
description: "Create a new Visual Layer dataset by pointing to a public or private S3 bucket using the cloud API."
---

<Card title="How This Helps" icon="hand-platter">
Creating a dataset from S3 is the recommended approach for production workflows. Point the API at your S3 bucket path and Visual Layer handles ingestion, indexing, and clustering automatically.
</Card>

<Note>
Use `status_new` for all status checks. The `status` field is being retired. See [Retrieve Dataset Status](/api-reference/retrieve-dataset-status).
Use `status_new` for all status checks. The `status` field is being retired. See [Retrieve Dataset Status](/api-reference/retrieve-dataset-status).
</Note>

## Prerequisites
Expand All @@ -32,7 +32,7 @@ Content-Type: multipart/form-data
### Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| --- | --- | --- | --- |
| `dataset_name` | string | Yes | The display name for the new dataset. |
| `bucket_path` | string | Yes | S3 path to the bucket or folder containing your media files. |

Expand All @@ -57,7 +57,7 @@ curl -X POST \
Save the `dataset_id` — you need it for all subsequent operations on this dataset.

<Tip>
Dataset creation is asynchronous. After the initial request, poll `GET /api/v1/dataset/{dataset_id}` until `status_new` is `READY` before running search or export operations.
Dataset creation is asynchronous. After the initial request, poll `GET /api/v1/dataset/{dataset_id}` until `status_new` is `READY` before running search or export operations.
</Tip>

---
Expand Down Expand Up @@ -124,7 +124,7 @@ print(f"Dataset ready: {dataset_id}")
See [Error Handling](/api-reference/errors) for the error response format and Python handling patterns.

| HTTP Code | Meaning |
|-----------|---------|
| --- | --- |
| **200** | Dataset created successfully. |
| **400** | Bad Request — missing or invalid parameters. |
| **401** | Unauthorized — check your JWT token. |
Expand All @@ -138,7 +138,8 @@ See [Error Handling](/api-reference/errors) for the error response format and Py
<Card title="Retrieve Dataset Status" icon="circle-check" href="/api-reference/retrieve-dataset-status">
Poll dataset status until processing completes.
</Card>

<Card title="Add Media to an Existing Dataset" icon="database" href="/api-reference/add-media-to-existing-dataset">
Incrementally add new media to an indexed dataset.
</Card>
</CardGroup>
</CardGroup>