Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Reject variant on an asset

Rejects one variant.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Rejects one variant. Its slot is freed and the next :generate fills it; the rejected file keeps serving at its URL.

Not available yet. Sylphx Generated Assets is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/assets/asset:rejectVariant
  • Scope assets:write
  • Effect write — a successful call changes state.
  • Collection assets

#Request

FieldTypeWhat it is
namestringThe name of the asset. Required.
content_hashstringThe content hash of the variant, 64 lowercase hex characters. Required.

#Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/assets/{asset}, where {asset} is the 16-hex logical key.
uidstringast_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
keystringThe logical key: 16 lowercase hex characters computed from the recipe. Output only.
kindAssetKindWhat kind of asset this is. Output only. One of image, sfx, music, video, character, voice.
recipeAssetRecipeThe recipe the asset was declared with. Output only.
canonicalstringThe exact text the key is the hash of. Output only.
variants_wantedint32How many variants the recipe asks for. Output only.
stateAssetStateWhere the asset is in its life. Output only. One of pending, ready, approved, failed, refused, unsupported.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
seedstringThe seed of the asset, a decimal integer as a string. Output only.
variantsVariant[]The stored variants, ordered by slot. Output only.
create_timetimestampWhen the asset was first generated. Output only.
update_timetimestampWhen the asset last changed. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#AssetRecipe

FieldTypeWhat it is
kindAssetKindWhat kind of asset to make. Required. One of image, sfx, music, video, character, voice.
promptstringWhat to make, at most 8000 bytes. Empty only for ASSET_KIND_CHARACTER. Required.
localestringThe locale of the asset, a BCP 47 tag; empty for images.
character_idstringThe character this asset shows; only for ASSET_KIND_CHARACTER, encoded in the canonical text as id=.
paramsmap<string, string>Kind-specific parameters in canonical text form, such as "2", "1024x768", "true" or a 16-hex key. At most 16 pairs; keys are [a-z_] up to 32 characters, values up to 256 characters.
keystringThe key the caller computed, 16 lowercase hex characters. When it differs from the server's, the call is refused with INVALID_FIELD and the problem carries the server's canonical text, which catches encoder drift.

#Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

#Variant

FieldTypeWhat it is
slotint32The slot the variant fills, from 0. Output only.
content_hashstringThe SHA-256 of the file's bytes, 64 lowercase hex characters. Output only.
urlstringThe immutable public URL: the project's base URL, then the content hash and extension. Output only.
media_typestringThe file's media type, such as image/png. Output only.
extstringThe file's extension without the dot, such as png. Output only.
widthint32Width in pixels. Output only.
heightint32Height in pixels. Output only.
bytesint64The file's size in bytes. Output only.
modelstringThe model that made this variant. Output only.
seedstringThe seed this variant was made with, a decimal integer as a string. Output only.
review_stateReviewStateThe human review of the variant. Output only. One of unreviewed, approved, rejected, retired.
qa_stateQaStateThe result of QA on the file. Output only. One of passed, warning, failed.
findingsQaFinding[]What QA found. Output only.
content_credentialsboolWhether the file carries content credentials. Output only.
approved_bystringThe principal that approved the variant; empty until it is approved. Output only.
create_timetimestampWhen the variant was stored. Output only.

#QaFinding

FieldTypeWhat it is
checkQaCheckThe check that found it. Output only. One of format, size, content_credentials, moderation.
severityQaSeverityHow serious it is. Output only. One of error, warning.
messagestringWhat is wrong. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/assets/asset:rejectVariant" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content_hash":"…"}'