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 Search by Name endpoint retrieves all artifacts that exactly match a given name. This is useful for finding specific artifacts when you know their registered name.

​
Endpoint

GET /artifact/byName/{name}

​
Path Parameters

​
name
string
required
Exact name of the artifact to search for. The name is matched after trimming whitespace. Use URL encoding for names containing special characters or slashes

​
Response

Returns an array of artifact metadata objects. Multiple artifacts may have the same name.
​
artifacts
array

​
Matching Behavior

  • Exact match: The name must match exactly after trimming leading/trailing whitespace
  • Case-sensitive: Names are matched as-is, with no case normalization
  • No wildcards: Unlike the list endpoint, this does not support wildcard matching
  • Empty results: Returns an empty array [] if no artifacts match (200 status, not 404)

​
Response Format

The endpoint always returns status 200 OK, even when no artifacts are found. An empty result set is represented as an empty array.

​
Examples

​
Search for Model by Name

curl https://api.example.com/artifact/byName/bert-base-uncased

​
Search for Hugging Face Model

For Hugging Face models, use the full model identifier: 
curl https://api.example.com/artifact/byName/facebook/opt-125m
Note: The forward slash must be URL-encoded as %2F in some clients: 
curl https://api.example.com/artifact/byName/facebook%2Fopt-125m

​
Search for Dataset

curl https://api.example.com/artifact/byName/imagenet-1k

​
Search with No Matches

curl https://api.example.com/artifact/byName/nonexistent-artifact
Returns: 
[]

​
Response Example (Single Match)

[
  {
    "name": "bert-base-uncased",
    "id": "1",
    "type": "model"
  }
]

​
Response Example (Multiple Matches)

If multiple artifacts share the same name: 
[
  {
    "name": "training-dataset",
    "id": "5",
    "type": "dataset"
  },
  {
    "name": "training-dataset",
    "id": "12",
    "type": "dataset"
  }
]

​
Use Cases

​
Verify Artifact Exists

Check if an artifact with a specific name has been registered: 
result=$(curl -s https://api.example.com/artifact/byName/my-model)
if [ "$result" = "[]" ]; then
  echo "Artifact not found"
else
  echo "Artifact exists"
fi

​
Get Artifact ID from Name

Retrieve the ID for a known artifact name: 
curl https://api.example.com/artifact/byName/bert-base-uncased | jq '.[0].id'

​
Find All Versions

If you use versioned naming (e.g., model-v1, model-v2), you’ll need to make separate requests for each version. For broader searches, use the regex endpoint instead.

​
Comparison with Other Search Endpoints

FeaturebyNamebyRegExPOST /artifacts
Match typeExactPatternName + Type filter
WildcardsNoYes (regex)Yes ("*")
Search model cardsNoYesNo
PaginationNoNoYes
Type filteringNoNoYes
For fuzzy matching or searching within model cards, use the regex search endpoint.

Build docs developers (and LLMs) love

Get started for freeTalk to us