Create a dataset

Create a private-by-default dataset whose immutable version pins exact task versions.

POST /api/v1/users/{user_id}/registry/datasets

Create a dataset

cURL

curl --request POST \
  --url https://sprites-gateway.api.synthlabs.ai/api/v1/users/{user_id}/registry/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "task_refs": [
    "<string>"
  ]
}
'

201

{
  "package": {
    "access": "owned",
    "canonical_ref": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kind": "task",
    "mutable": true,
    "name": "<string>",
    "namespace": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "visibility": "private",
    "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "display_name": "<string>"
  },
  "version_total": 1,
  "versions": [
    {
      "content_digest": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "immutable_ref": "<string>",
      "media_type": "<string>",
      "revision": 2,
      "size_bytes": 1,
      "member_limit": 0,
      "member_offset": 0,
      "member_total": 1,
      "members": [
        {
          "position": 1,
          "task_content_digest": "<string>",
          "task_ref": "<string>",
          "task_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "published_at": "2023-11-07T05:31:56Z",
      "tags": [
        "<string>"
      ],
      "yank_reason": "<string>",
      "yanked_at": "2023-11-07T05:31:56Z"
    }
  ],
  "contract_version": "synth.registry.v1",
  "version_limit": 1000,
  "version_offset": 0
}

Authorizations

Authorization · string · header · required

Synth customer access token for the current user and organization.

Headers

Idempotency-Key · string · required

Required string length: 1 - 100

Path Parameters

user_id · string<uuid> · required

Body

application/json

Publish one immutable dataset version from exact visible task versions.

name · string · required

Required string length: 1 - 255

Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$

task_refs · string[] · required

Required array length: 1 - 1000 elements

description · string | null

Maximum string length: 2000

expected_current_version_id · string<uuid> | null

package_id · string<uuid> | null

tags · string[]

Maximum array length: 32

visibility · enum<string> · default: private

Available options: private, org, public

Response

201

application/json

Successful Response

One package and its immutable published version history.

package · RegistryCatalogItem · object · required

Safe package summary without storage, actor, or tenant identifiers.

Show child attributes

version_total · integer · required

Required range: x >= 0

versions · RegistryPackageVersion · object[] · required

Show child attributes

contract_version · enum<string> · default: synth.registry.v1

Available options: synth.registry.v1

Allowed value: "synth.registry.v1"

version_limit · integer · default: 1000

Required range: 1 <= x <= 1000

version_offset · integer · default: 0

Required range: x >= 0