Skip to content

Upload an artifact

POST
/v1/artifacts
curl --request POST \
--url https://example.com/v1/artifacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@file \
--form name=example \
--form contentType=example \
--form 'tags="example"' \
--form ownerRunId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--form expectedHash=example

Multipart upload. file part carries the bytes; other form fields carry metadata (name, contentType, tags (JSON), ownerRunId, expectedHash). Framework computes sha256 and returns it in BlobMeta.hash. If expectedHash was supplied and diverges, response is 400 blob-hash-mismatch. Content-type sniffing is NOT performed server-side — the framework trusts the caller.

Idempotency-Key
string
>= 1 characters

Caller-supplied idempotency key. Retries with the same key return the original response byte-identical (per docs/API-ROUTE-CONVENTIONS.md §3.1).

Media typemultipart/form-data

Multipart form. file is the byte stream (required). Other fields are optional metadata: name (defaults to file part filename), contentType (defaults to file part MIME), tags (JSON-encoded object), ownerRunId (RunId string), expectedHash (sha256 hex, framework rejects on mismatch).

object
file
required
string format: binary
name
string
contentType
string
tags

JSON-encoded Record<string, string> — parsed server-side.

string
ownerRunId
string format: uuid
expectedHash

Caller-computed sha256, hex-encoded, lowercase. Framework verifies + rejects on mismatch with blob-hash-mismatch (400).

string
/^[0-9a-f]{64}$/

Upload accepted; metadata returned.

Media typeapplication/json
object
blobId
required

ArtifactId — opaque branded string (a UUID).

string
tenantId
required
string format: uuid
name
required

Caller-supplied filename or logical name.

string
contentType
required

MIME type as declared by the uploader. Framework does NOT sniff content-type server-side.

string
size
required

Byte length of the persisted body.

integer
hash
required

Sha256 of the body, hex-encoded, lowercase (64 chars).

string
/^[0-9a-f]{64}$/
tags
required

Free-form caller-supplied labels. Filterable on list via ?tag.<key>=<value>.

object
key
additional properties
string
ownerRunId

Optional back-ref to the RunId that produced this blob.

string format: uuid
createdAt
required
string format: date-time
Examplegenerated
{
"blobId": "example",
"tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"contentType": "example",
"size": 1,
"hash": "example",
"tags": {
"additionalProperty": "example"
},
"ownerRunId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"createdAt": "2026-04-15T12:00:00Z"
}

Malformed multipart body, bad tag JSON, hash mismatch, or declared size mismatch.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}

Idempotency-Key was reused with a different body, or resource-state conflict.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}

Server error (unmapped domain code or framework crash).

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}