Skip to main content
GET
/
artifacts
/
{artifact_type}
/
{id}
Retrieve Artifact
curl --request GET \
  --url https://api.example.com/artifacts/{artifact_type}/{id}
{
  "metadata": {
    "metadata.name": "<string>",
    "metadata.id": "<string>",
    "metadata.type": "<string>"
  },
  "data": {
    "data.url": "<string>",
    "data.download_url": "<string>"
  },
  "response": [
    {
      "name": "<string>",
      "id": "<string>",
      "type": "<string>"
    }
  ]
}

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.

​
Endpoints

There are two ways to retrieve artifacts:

​
1. Get by Type and ID

GET /artifacts/{artifact_type}/{id}
Fetch a specific artifact by its type and unique identifier.

​
2. Get by Name

GET /artifact/byName/{name}
Find all artifacts matching an exact name.

​
Get by Type and ID

​
Parameters

​
artifact_type
string
required
Type of artifact to retrieve:
  • model - Machine learning model
  • dataset - Training or evaluation dataset
  • code - Code repository or script
​
id
string
required
Unique identifier of the artifact. Must be alphanumeric (may include hyphens).Examples: 12345, abc-123, model-001

​
Response

Returns the artifact with metadata and data fields.
​
metadata
object
required
Artifact metadata
​
metadata.name
string
Name of the artifact
​
metadata.id
string
Unique identifier
​
metadata.type
string
Artifact type: model, dataset, or code
​
data
object
required
Artifact data and URLs
​
data.url
string
Source URL of the artifact
​
data.download_url
string
Pre-signed download URL (if available)For model artifacts, this is typically an S3 pre-signed URL valid for a limited time.For dataset/code artifacts, this may be null if no download was uploaded.

​
Error Codes

  • 400 - Invalid artifact type or malformed ID
  • 404 - Artifact not found
  • 500 - Internal server error

​
Examples

curl https://api.example.com/artifacts/model/12345

​
Response Example

{
  "metadata": {
    "name": "BERT Base Uncased",
    "id": "12345",
    "type": "model"
  },
  "data": {
    "url": "https://huggingface.co/google-bert/bert-base-uncased",
    "download_url": "https://s3.amazonaws.com/bucket/artifacts/model/12345.zip?signature=..."
  }
}

​
Get by Name

​
Endpoint

GET /artifact/byName/{name}

​
Parameters

​
name
string
required
Exact name of the artifact(s) to find. The name is matched after trimming whitespace.Use path encoding for names with special characters or slashes:
  • google-bert/bert-base-uncased → google-bert%2Fbert-base-uncased

​
Response

Returns an array of matching artifacts (may be empty if no matches found).
​
response
array
Array of artifact metadata objects
​
name
string
Artifact name
​
id
string
Unique identifier
​
type
string
Artifact type: model, dataset, or code

​
Behavior Notes

  • Always returns HTTP 200, even when no artifacts match
  • Returns empty array [] if no matches found
  • Does NOT return 404 for zero matches (spec-compliant behavior)
  • Results are sorted by ID for deterministic ordering
  • Matching is exact and case-sensitive (after trimming)

​
Examples

curl https://api.example.com/artifact/byName/my-model

​
Response Examples

Multiple matches found: 
[
  {
    "name": "google-bert/bert-base-uncased",
    "id": "12345",
    "type": "model"
  },
  {
    "name": "google-bert/bert-base-uncased",
    "id": "12346",
    "type": "model"
  }
]
No matches found: 
[]

​
Additional Retrieval Endpoints

​
Search by Regular Expression

POST /artifact/byRegEx
Search artifact names and model cards using regex patterns. Request: 
{
  "regex": "bert.*uncased"
}
Response: Array of matching artifact metadata (same format as byName).

​
List All Artifacts

POST /artifacts
Enumerate artifacts with filtering and pagination. Request: 
[
  {
    "name": "*",
    "types": ["model", "dataset"]
  }
]
Response: Paginated array of artifact metadata. Check offset response header for next page.

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us