Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/GingerlyData247/SOTeam4-P2/llms.txt

Use this file to discover all available pages before exploring further.

Overview

The List Artifacts endpoint allows you to enumerate all artifacts in the registry with optional filtering by name and type, plus pagination support for large result sets.

Endpoint

POST /artifacts

Request Body

The request body accepts an array of query objects. Currently, only the first query is processed.
queries
array
required
Array of artifact query objects

Query Parameters

offset
string
Pagination offset. Start retrieving results from this index (0-based)

Response

Returns an array of artifact metadata objects.
artifacts
array

Response Headers

offset
string
Next pagination offset. Present only if more results are available. Use this value in the next request’s offset query parameter

Pagination

The endpoint returns up to 1000 artifacts per request. When more results are available, the response includes an offset header indicating where to start the next request.

Filter by Artifact Type

You can filter artifacts by type using the types array:
  • MODEL: Machine learning models from Hugging Face or other sources
  • DATASET: Training or evaluation datasets
  • CODE: Code repositories or implementations

Examples

List All Artifacts

curl -X POST https://api.example.com/artifacts \
  -H "Content-Type: application/json" \
  -d '{
    "queries": [{
      "name": "*"
    }]
  }'

List Models Only

curl -X POST https://api.example.com/artifacts \
  -H "Content-Type: application/json" \
  -d '{
    "queries": [{
      "name": "*",
      "types": ["model"]
    }]
  }'

List Specific Artifact by Name

curl -X POST https://api.example.com/artifacts \
  -H "Content-Type: application/json" \
  -d '{
    "queries": [{
      "name": "bert-base-uncased"
    }]
  }'

Paginated Request

# First page
curl -X POST https://api.example.com/artifacts \
  -H "Content-Type: application/json" \
  -d '{
    "queries": [{
      "name": "*",
      "types": ["model", "dataset"]
    }]
  }' \
  -i

# Next page (using offset from response header)
curl -X POST https://api.example.com/artifacts?offset=1000 \
  -H "Content-Type: application/json" \
  -d '{
    "queries": [{
      "name": "*",
      "types": ["model", "dataset"]
    }]
  }'

Response Example

[
  {
    "name": "bert-base-uncased",
    "id": "1",
    "type": "model"
  },
  {
    "name": "imagenet-1k",
    "id": "2",
    "type": "dataset"
  },
  {
    "name": "training-scripts",
    "id": "3",
    "type": "code"
  }
]

Build docs developers (and LLMs) love