Search one Artifact Family in a Scope

POST
/v1/scopes/{scope_id}/artifacts/{family}/search

Search registered Artifact Families using their supported retrieval controls. Results contain complete exact Artifact revisions. Score metadata is returned only when requested; min_score compares normalized retrieval scores.

Authorization

BearerAuth
AuthorizationBearer <token>

Bearer credential resolved to an opaque authenticated Principal by the Server deployment.

In: header

Path Parameters

scope_id*string
Match.*\S.*
Length1 <= length <= 256
family*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/scopes/string/artifacts/string/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
{  "results": [    {      "family": "string",      "artifact_id": "string",      "revision": 1,      "content": {},      "lineage": {},      "scores": {        "retrieval": 0,        "channels": {          "property1": {            "raw": 0,            "metric": "string",            "higher_is_better": true          },          "property2": {            "raw": 0,            "metric": "string",            "higher_is_better": true          }        }      }    }  ]}