Skip to main content
POST
/
api
/
v1
/
volumes
/
@
{scope}
/
{name}
/
uploads
/
{uploadId}
/
finalize
Finalize a release upload for a scoped volume
curl --request POST \
  --url https://api.example.com/api/v1/volumes/@{scope}/{name}/uploads/{uploadId}/finalize \
  --header 'Authorization: Bearer <token>'
{
  "uploadId": "<string>",
  "release": {
    "name": "<string>",
    "version": "<string>",
    "purl": "<string>",
    "integrity": "<string>",
    "status": {
      "reason": "<string>"
    },
    "dist": {
      "source": "<string>",
      "mediaType": "<string>",
      "url": "<string>"
    },
    "externalDependencies": [
      {
        "declarationKey": "<string>",
        "purl": "<string>",
        "constraint": "<string>",
        "components": [
          "<string>"
        ]
      }
    ]
  },
  "detailUrl": "<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.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Preferred portable idempotency key for finalize. If an operation also accepts a body idempotencyKey, the two values MUST match exactly.

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])?$
​
uploadId
string
required

Response

Published release metadata

​
uploadId
string
required
Minimum string length: 1
​
release
Agent Volumes Release Metadata · object
required
​
detailUrl
string<uri-reference>
required