Rork Background Asset Versions API
The BackgroundAssetVersions API from Rork — 4 operation(s) for backgroundassetversions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/rork:rork-backgroundassetversions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: App Store Connect Background Asset Versions API
version: 4.5.1
x-platforms:
app_store_connect_api: App Store Connect API
servers:
- url: https://api.appstoreconnect.apple.com/
security:
- itc-bearer-token: []
tags:
- name: BackgroundAssetVersions
paths:
/v1/backgroundAssetVersions:
post:
tags:
- BackgroundAssetVersions
operationId: backgroundAssetVersions_createInstance
requestBody:
description: BackgroundAssetVersion representation
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundAssetVersionCreateRequest'
required: true
responses:
'400':
description: Parameter error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Unprocessable request entity error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'201':
description: Single BackgroundAssetVersion
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundAssetVersionResponse'
'409':
description: Request entity error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Background asset versions create instance
x-summary-source: derived
/v1/backgroundAssetVersions/{id}:
parameters:
- name: id
in: path
description: the id of the requested resource
schema:
type: string
style: simple
required: true
get:
tags:
- BackgroundAssetVersions
operationId: backgroundAssetVersions_getInstance
parameters:
- name: fields[backgroundAssetVersions]
in: query
description: the fields to include for returned resources of type backgroundAssetVersions
schema:
type: array
items:
type: string
enum:
- createdDate
- platforms
- state
- stateDetails
- version
- locale
- backgroundAsset
- internalBetaRelease
- externalBetaRelease
- appStoreRelease
- assetFile
- manifestFile
- backgroundAssetUploadFiles
style: form
explode: false
required: false
- name: fields[backgroundAssets]
in: query
description: the fields to include for returned resources of type backgroundAssets
schema:
type: array
items:
type: string
enum:
- archived
- assetPackIdentifier
- createdDate
- usedBytes
- app
- versions
- appStoreVersion
- internalBetaVersion
- externalBetaVersion
style: form
explode: false
required: false
- name: fields[backgroundAssetVersionInternalBetaReleases]
in: query
description: the fields to include for returned resources of type backgroundAssetVersionInternalBetaReleases
schema:
type: array
items:
type: string
enum:
- state
- backgroundAssetVersion
style: form
explode: false
required: false
- name: fields[backgroundAssetVersionExternalBetaReleases]
in: query
description: the fields to include for returned resources of type backgroundAssetVersionExternalBetaReleases
schema:
type: array
items:
type: string
enum:
- state
- backgroundAssetVersion
style: form
explode: false
required: false
- name: fields[backgroundAssetVersionAppStoreReleases]
in: query
description: the fields to include for returned resources of type backgroundAssetVersionAppStoreReleases
schema:
type: array
items:
type: string
enum:
- state
- backgroundAssetVersion
style: form
explode: false
required: false
- name: fields[backgroundAssetUploadFiles]
in: query
description: the fields to include for returned resources of type backgroundAssetUploadFiles
schema:
type: array
items:
type: string
enum:
- assetDeliveryState
- assetToken
- assetType
- fileName
- fileSize
- sourceFileChecksum
- sourceFileChecksums
- uploadOperations
style: form
explode: false
required: false
- name: include
in: query
description: comma-separated list of relationships to include
schema:
type: array
items:
type: string
enum:
- backgroundAsset
- internalBetaRelease
- externalBetaRelease
- appStoreRelease
- assetFile
- manifestFile
style: form
explode: false
required: false
responses:
'400':
description: Parameter error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: Single BackgroundAssetVersion
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundAssetVersionResponse'
'429':
description: Rate limit exceeded error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Background asset versions get instance
x-summary-source: derived
/v1/backgroundAssetVersions/{id}/relationships/backgroundAssetUploadFiles:
parameters:
- name: id
in: path
description: the id of the requested resource
schema:
type: string
style: simple
required: true
get:
tags:
- BackgroundAssetVersions
operationId: backgroundAssetVersions_backgroundAssetUploadFiles_getToManyRelationship
parameters:
- name: limit
in: query
description: maximum resources per page
schema:
type: integer
maximum: 200
style: form
responses:
'400':
description: Parameter error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: List of related linkages
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundAssetVersionBackgroundAssetUploadFilesLinkagesResponse'
'429':
description: Rate limit exceeded error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Background asset versions background asset upload files get to many relationship
x-summary-source: derived
/v1/backgroundAssetVersions/{id}/backgroundAssetUploadFiles:
parameters:
- name: id
in: path
description: the id of the requested resource
schema:
type: string
style: simple
required: true
get:
tags:
- BackgroundAssetVersions
operationId: backgroundAssetVersions_backgroundAssetUploadFiles_getToManyRelated
parameters:
- name: fields[backgroundAssetUploadFiles]
in: query
description: the fields to include for returned resources of type backgroundAssetUploadFiles
schema:
type: array
items:
type: string
enum:
- assetDeliveryState
- assetToken
- assetType
- fileName
- fileSize
- sourceFileChecksum
- sourceFileChecksums
- uploadOperations
style: form
explode: false
- name: limit
in: query
description: maximum resources per page
schema:
type: integer
maximum: 200
style: form
responses:
'400':
description: Parameter error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized error(s)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: List of BackgroundAssetUploadFiles
content:
application/json:
schema:
$ref: '#/components/schemas/BackgroundAssetUploadFilesResponse'
'429':
description: Rate limit exceeded error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Background asset versions background asset upload files get to many related
x-summary-source: derived
components:
schemas:
AppMediaStateError:
type: object
properties:
code:
type: string
description:
type: string
BackgroundAssetVersionResponse:
type: object
title: BackgroundAssetVersionResponse
properties:
data:
$ref: '#/components/schemas/BackgroundAssetVersion'
included:
type: array
items:
oneOf:
- $ref: '#/components/schemas/BackgroundAssetUploadFile'
- $ref: '#/components/schemas/BackgroundAssetVersionAppStoreRelease'
- $ref: '#/components/schemas/BackgroundAssetVersionExternalBetaRelease'
- $ref: '#/components/schemas/BackgroundAssetVersionInternalBetaRelease'
- $ref: '#/components/schemas/BackgroundAsset'
discriminator:
propertyName: type
mapping:
backgroundAssetVersionAppStoreReleases: '#/components/schemas/BackgroundAssetVersionAppStoreRelease'
backgroundAssetVersionInternalBetaReleases: '#/components/schemas/BackgroundAssetVersionInternalBetaRelease'
backgroundAssets: '#/components/schemas/BackgroundAsset'
backgroundAssetUploadFiles: '#/components/schemas/BackgroundAssetUploadFile'
backgroundAssetVersionExternalBetaReleases: '#/components/schemas/BackgroundAssetVersionExternalBetaRelease'
links:
$ref: '#/components/schemas/DocumentLinks'
required:
- data
- links
BackgroundAssetUploadFilesResponse:
type: object
title: BackgroundAssetUploadFilesResponse
properties:
data:
type: array
items:
$ref: '#/components/schemas/BackgroundAssetUploadFile'
links:
$ref: '#/components/schemas/PagedDocumentLinks'
meta:
$ref: '#/components/schemas/PagingInformation'
required:
- data
- links
ErrorSourceParameter:
type: object
title: Parameter
properties:
parameter:
type: string
required:
- parameter
BackgroundAssetVersionCreateRequest:
type: object
title: BackgroundAssetVersionCreateRequest
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersions
relationships:
type: object
properties:
backgroundAsset:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssets
id:
type: string
required:
- id
- type
required:
- data
required:
- backgroundAsset
required:
- relationships
- type
required:
- data
Platform:
type: string
enum:
- IOS
- MAC_OS
- TV_OS
- VISION_OS
BackgroundAssetVersionExternalBetaRelease:
type: object
title: BackgroundAssetVersionExternalBetaRelease
properties:
type:
type: string
enum:
- backgroundAssetVersionExternalBetaReleases
id:
type: string
attributes:
type: object
properties:
state:
$ref: '#/components/schemas/BackgroundAssetVersionExternalBetaReleaseState'
relationships:
type: object
properties:
backgroundAssetVersion:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersions
id:
type: string
required:
- id
- type
links:
$ref: '#/components/schemas/ResourceLinks'
required:
- id
- type
ErrorLinks:
type: object
properties:
about:
type: string
format: uri-reference
associated:
oneOf:
- type: string
format: uri-reference
- type: object
properties:
href:
type: string
format: uri-reference
meta:
type: object
properties:
source:
type: string
BackgroundAssetUploadFile:
type: object
title: BackgroundAssetUploadFile
properties:
type:
type: string
enum:
- backgroundAssetUploadFiles
id:
type: string
attributes:
type: object
properties:
assetDeliveryState:
$ref: '#/components/schemas/AppMediaAssetState'
assetToken:
type: string
assetType:
type: string
enum:
- ASSET
- MANIFEST
fileName:
type: string
fileSize:
type: integer
format: int64
maximum: 9007199254740991
minimum: 1
sourceFileChecksum:
type: string
deprecated: true
sourceFileChecksums:
$ref: '#/components/schemas/Checksums'
uploadOperations:
type: array
items:
$ref: '#/components/schemas/DeliveryFileUploadOperation'
links:
$ref: '#/components/schemas/ResourceLinks'
required:
- id
- type
BackgroundAssetVersionState:
type: string
enum:
- AWAITING_UPLOAD
- PROCESSING
- FAILED
- COMPLETE
BackgroundAssetVersionExternalBetaReleaseState:
type: string
enum:
- READY_FOR_BETA_SUBMISSION
- WAITING_FOR_REVIEW
- IN_REVIEW
- REJECTED
- PROCESSING_FOR_TESTING
- READY_FOR_TESTING
- SUPERSEDED
BackgroundAsset:
type: object
title: BackgroundAsset
properties:
type:
type: string
enum:
- backgroundAssets
id:
type: string
attributes:
type: object
properties:
archived:
type: boolean
assetPackIdentifier:
type: string
createdDate:
type: string
format: date-time
usedBytes:
type: integer
format: int64
maximum: 9007199254740991
minimum: 0
relationships:
type: object
properties:
app:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- apps
id:
type: string
required:
- id
- type
versions:
type: object
properties:
links:
$ref: '#/components/schemas/RelationshipLinks'
appStoreVersion:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersions
id:
type: string
required:
- id
- type
internalBetaVersion:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersions
id:
type: string
required:
- id
- type
externalBetaVersion:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersions
id:
type: string
required:
- id
- type
links:
$ref: '#/components/schemas/ResourceLinks'
required:
- id
- type
DeliveryFileUploadOperation:
type: object
properties:
method:
type: string
url:
type: string
length:
type: integer
format: int64
maximum: 9007199254740991
minimum: 1
offset:
type: integer
format: int64
maximum: 9007199254740991
minimum: 0
requestHeaders:
type: array
items:
$ref: '#/components/schemas/HttpHeader'
expiration:
type: string
format: date-time
partNumber:
type: integer
format: int64
maximum: 9007199254740991
minimum: 1
entityTag:
type: string
DocumentLinks:
type: object
properties:
self:
type: string
format: uri-reference
required:
- self
BackgroundAssetVersionInternalBetaRelease:
type: object
title: BackgroundAssetVersionInternalBetaRelease
properties:
type:
type: string
enum:
- backgroundAssetVersionInternalBetaReleases
id:
type: string
attributes:
type: object
properties:
state:
type: string
enum:
- READY_FOR_TESTING
- SUPERSEDED
relationships:
type: object
properties:
backgroundAssetVersion:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersions
id:
type: string
required:
- id
- type
links:
$ref: '#/components/schemas/ResourceLinks'
required:
- id
- type
AppMediaAssetState:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/AppMediaStateError'
warnings:
type: array
items:
$ref: '#/components/schemas/AppMediaStateError'
state:
type: string
enum:
- AWAITING_UPLOAD
- UPLOAD_COMPLETE
- COMPLETE
- FAILED
ErrorSourcePointer:
type: object
title: JsonPointer
properties:
pointer:
type: string
required:
- pointer
BackgroundAssetVersionAppStoreRelease:
type: object
title: BackgroundAssetVersionAppStoreRelease
properties:
type:
type: string
enum:
- backgroundAssetVersionAppStoreReleases
id:
type: string
attributes:
type: object
properties:
state:
$ref: '#/components/schemas/BackgroundAssetVersionAppStoreReleaseState'
relationships:
type: object
properties:
backgroundAssetVersion:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersions
id:
type: string
required:
- id
- type
links:
$ref: '#/components/schemas/ResourceLinks'
required:
- id
- type
BackgroundAssetVersionAppStoreReleaseState:
type: string
enum:
- PREPARE_FOR_SUBMISSION
- READY_FOR_REVIEW
- WAITING_FOR_REVIEW
- IN_REVIEW
- ACCEPTED
- REJECTED
- PROCESSING_FOR_DISTRIBUTION
- READY_FOR_DISTRIBUTION
- SUPERSEDED
PagingInformation:
type: object
properties:
paging:
type: object
properties:
total:
type: integer
limit:
type: integer
nextCursor:
type: string
required:
- limit
required:
- paging
BackgroundAssetVersionBackgroundAssetUploadFilesLinkagesResponse:
type: object
properties:
data:
type: array
items:
type: object
properties:
type:
type: string
enum:
- backgroundAssetUploadFiles
id:
type: string
required:
- id
- type
links:
$ref: '#/components/schemas/PagedDocumentLinks'
meta:
$ref: '#/components/schemas/PagingInformation'
required:
- data
- links
ErrorResponse:
type: object
properties:
errors:
type: array
items:
type: object
properties:
id:
type: string
status:
type: string
code:
type: string
title:
type: string
detail:
type: string
source:
oneOf:
- $ref: '#/components/schemas/ErrorSourcePointer'
- $ref: '#/components/schemas/ErrorSourceParameter'
links:
$ref: '#/components/schemas/ErrorLinks'
meta:
type: object
additionalProperties: {}
required:
- code
- detail
- status
- title
StateDetail:
type: object
properties:
code:
type: string
description:
type: string
RelationshipLinks:
type: object
properties:
self:
type: string
format: uri-reference
related:
type: string
format: uri-reference
ChecksumAlgorithm:
type: string
enum:
- MD5
- SHA_256
HttpHeader:
type: object
properties:
name:
type: string
value:
type: string
Checksums:
type: object
properties:
file:
type: object
properties:
hash:
type: string
algorithm:
$ref: '#/components/schemas/ChecksumAlgorithm'
composite:
type: object
properties:
hash:
type: string
algorithm:
type: string
enum:
- MD5
BackgroundAssetVersion:
type: object
title: BackgroundAssetVersion
properties:
type:
type: string
enum:
- backgroundAssetVersions
id:
type: string
attributes:
type: object
properties:
createdDate:
type: string
format: date-time
platforms:
type: array
items:
$ref: '#/components/schemas/Platform'
state:
$ref: '#/components/schemas/BackgroundAssetVersionState'
stateDetails:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/StateDetail'
warnings:
type: array
items:
$ref: '#/components/schemas/StateDetail'
infos:
type: array
items:
$ref: '#/components/schemas/StateDetail'
version:
type: string
locale:
type: string
relationships:
type: object
properties:
backgroundAsset:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssets
id:
type: string
required:
- id
- type
internalBetaRelease:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersionInternalBetaReleases
id:
type: string
required:
- id
- type
externalBetaRelease:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersionExternalBetaReleases
id:
type: string
required:
- id
- type
appStoreRelease:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetVersionAppStoreReleases
id:
type: string
required:
- id
- type
assetFile:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetUploadFiles
id:
type: string
required:
- id
- type
manifestFile:
type: object
properties:
data:
type: object
properties:
type:
type: string
enum:
- backgroundAssetUploadFiles
id:
type: string
required:
- id
- type
backgroundAssetUploadFiles:
type: object
properties:
links:
$ref: '#/components/schemas/RelationshipLinks'
links:
$ref: '#/components/schemas/ResourceLinks'
required:
- id
- type
ResourceLinks:
type: object
properties:
self:
type: string
format: uri-reference
PagedDocumentLinks:
type: object
properties:
self:
type: string
format: uri-reference
first:
type: string
format: uri-reference
next:
type: string
format: uri-reference
required:
- self
securitySchemes:
itc-bearer-token:
type: http
scheme: bearer
bearerFormat: JWT