Get a task or dataset

Inspect one visible logical package and its immutable version history.

GET /api/v1/users/{user_id}/registry/packages/{kind}/{package_id}

Get a task or dataset

cURL

curl --request GET \
  --url https://sprites-gateway.api.synthlabs.ai/api/v1/users/{user_id}/registry/packages/{kind}/{package_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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.

Path Parameters

user_id · string<uuid> · required

kind · enum<string> · required

Available options: task, dataset

package_id · string<uuid> · required

Query Parameters

version_limit · integer · default: 100

Required range: 1 <= x <= 1000

version_offset · integer · default: 0

Required range: x >= 0

Response

200

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