Asset Library API
Retrieve Asset
- Support
- Authentication
- Inference
Account
Endpoint
Events & Logs
Secret
Registry Credential
Public Endpoints
Instance Types
OctoAI API
Asset Library API
Retrieve Asset
GET
/
v1
/
assets
/
{asset_owner_and_name_or_id}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
asset_owner_and_name_or_id
Asset Owner And Name Or Id · string
*
asset_owner_and_name_or_id
Required
string
transfer_api_type
Transfer Api Type · enum<string>
transfer_api_type
enum<string>
curl --request GET \
--url https://api.octoai.cloud/v1/assets/{asset_owner_and_name_or_id} \
--header 'Authorization: Bearer <token>'
{
"asset": {
"asset_type": "file",
"created_at": "<string>",
"data": {
"asset_type": "<any>",
"file_format": "unknown",
"preview_url": "<string>",
"version": "<string>"
},
"description": "<string>",
"id": "<string>",
"is_public": true,
"name": "<string>",
"size_bytes": 123,
"status": "ready_to_upload",
"status_details": "<string>",
"tenant_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"transfer_api": {
"get_url": "<string>",
"put_url": "<string>",
"type": "<any>"
}
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
asset_owner_and_name_or_id
string
requiredQuery Parameters
transfer_api_type
enum<string>
Available options:
presigned-url
, sts
Response
200 - application/json
asset
object
requiredAsset.
asset.asset_type
enum<string>
requiredAsset type.
Available options:
file
, checkpoint
, lora
, textual_inversion
, vae
, volume
asset.created_at
string
requiredAsset creation time.
asset.data
object
requiredAsset data.
asset.data.asset_type
any
Asset type.
asset.data.file_format
enum<string>
File format.
Available options:
unknown
, png
, jpg
, jpeg
, txt
asset.data.preview_url
string
Preview URL.
asset.data.version
string
default: Version.
asset.description
string
requiredDescription.
asset.id
string
requiredAsset id.
asset.is_public
boolean
default: falseTrue if asset is public.
asset.name
string
requiredAsset name.
asset.size_bytes
integer
requiredSize in bytes.
asset.status
enum<string>
requiredAsset status.
Available options:
ready_to_upload
, uploaded
, ready
, deleted
, rejected
, error
asset.status_details
string
requiredAsset status.
asset.tenant_uuid
string
requiredAsset tenant ID.
transfer_api
object
requiredTransfer API.
transfer_api.get_url
string
requiredGet asset URL.
transfer_api.put_url
string
requiredAsset URL to upload.
transfer_api.type
any
URL type.
Was this page helpful?
curl --request GET \
--url https://api.octoai.cloud/v1/assets/{asset_owner_and_name_or_id} \
--header 'Authorization: Bearer <token>'
{
"asset": {
"asset_type": "file",
"created_at": "<string>",
"data": {
"asset_type": "<any>",
"file_format": "unknown",
"preview_url": "<string>",
"version": "<string>"
},
"description": "<string>",
"id": "<string>",
"is_public": true,
"name": "<string>",
"size_bytes": 123,
"status": "ready_to_upload",
"status_details": "<string>",
"tenant_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"transfer_api": {
"get_url": "<string>",
"put_url": "<string>",
"type": "<any>"
}
}