Skip to main content
GET
/
api
/
v1
/
volumes
/
@
{scope}
/
{name}
/
{version}
Fetch scoped volume release metadata
curl --request GET \
  --url https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}
{
  "name": "<string>",
  "version": "<string>",
  "purl": "<string>",
  "integrity": "<string>",
  "status": {
    "reason": "<string>"
  },
  "externalDependencies": [
    {
      "declarationKey": "<string>",
      "purl": "<string>",
      "constraint": "<string>",
      "components": [
        "<string>"
      ]
    }
  ],
  "dist": {
    "source": "<string>",
    "mediaType": "<string>",
    "url": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://agentvolumes.mintlify.app/llms.txt

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

Path Parameters

​
scope
string
required
Maximum string length: 64
Pattern: ^(?!.*--)[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$
​
name
string
required
Maximum string length: 128
Pattern: ^(?!.*--)[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$
​
version
string
required
Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$

Response

Release metadata. Delivery metadata is subordinate to the release integrity value; clients reject resolved content whose normalized-file-tree digest does not match.

​
name
string
required
Maximum string length: 194
Pattern: ^(@(?!.*--)[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?/)?(?!.*--)[a-z0-9](?:[a-z0-9-]{0,126}[a-z0-9])?$
​
version
string
required
Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$
​
purl
string
required
Pattern: ^pkg:volume/(?:%40(?![a-z0-9-]*--)[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?/)?(?![a-z0-9-]*--)[a-z0-9](?:[a-z0-9-]{0,126}[a-z0-9])?@(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$
​
integrity
string
required
Pattern: ^sha256:[a-f0-9]{64}$
​
status
object
required
​
externalDependencies
object[]

Declaration-only external package dependency metadata derived from the release manifest. These records are not resolved dependency inventory, lockfile content, provenance material, scanner findings, or vulnerability evidence.

​
dist
object