Get an asset

client.Assets.Get(ctx, assetID) (*AssetGetResponse, error)

GET/assets/{assetId}

Returns metadata for one asset when it is accessible to the authenticated public API key. Missing and inaccessible assets both return 404.

ParametersExpand Collapse

assetID string

Asset identifier

ReturnsExpand Collapse

type AssetGetResponse struct{…}

AssetID string

Asset identifier

ContentType string

Asset content type

CreatedAt Time

Asset creation time (ISO 8601 datetime)

formatdate-time

Description string

Asset description

FailureMessage string

Failure message when the asset is in failed status

Height int64

Name string

Asset name

SizeBytes int64

Status AssetGetResponseStatus

One of the following:

const AssetGetResponseStatusPendingUpload AssetGetResponseStatus = "pending_upload"

const AssetGetResponseStatusReady AssetGetResponseStatus = "ready"

const AssetGetResponseStatusFailed AssetGetResponseStatus = "failed"

UploadContentType string

Content type provided at upload time

UploadedVia string

Asset source

URL string

Asset URL

formaturi

Width int64

WorkspaceID string

Workspace identifier

Get an asset

package main

import (
  "context"
  "fmt"

  "github.com/florafauna-ai/flora-go"
  "github.com/florafauna-ai/flora-go/option"
)

func main() {
  client := flora.NewClient(
    option.WithAPIKey("My API Key"),
  )
  asset, err := client.Assets.Get(context.TODO(), "asset_abc123")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", asset.AssetID)
}

{
  "asset_id": "asset_abc123",
  "content_type": "content_type",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "failure_message": "failure_message",
  "height": 0,
  "name": "name",
  "size_bytes": 0,
  "status": "pending_upload",
  "upload_content_type": "upload_content_type",
  "uploaded_via": "uploaded_via",
  "url": "https://example.com",
  "width": 0,
  "workspace_id": "ws_abc123"
}

{
  "error": {
    "code": "input_validation_error",
    "message": "prompt: Required",
    "fields": [
      {
        "field": "prompt",
        "message": "Required"
      }
    ]
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key."
  }
}

{
  "error": {
    "code": "insufficient_credits",
    "message": "Insufficient credits."
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Forbidden."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found."
  }
}

{
  "error": {
    "code": "idempotency_duplicate",
    "message": "Duplicate idempotency key."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded."
  }
}

{
  "error": {
    "code": "unknown_error",
    "message": "An unknown error occurred."
  }
}

Returns Examples

{
  "asset_id": "asset_abc123",
  "content_type": "content_type",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "failure_message": "failure_message",
  "height": 0,
  "name": "name",
  "size_bytes": 0,
  "status": "pending_upload",
  "upload_content_type": "upload_content_type",
  "uploaded_via": "uploaded_via",
  "url": "https://example.com",
  "width": 0,
  "workspace_id": "ws_abc123"
}

{
  "error": {
    "code": "input_validation_error",
    "message": "prompt: Required",
    "fields": [
      {
        "field": "prompt",
        "message": "Required"
      }
    ]
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid API key."
  }
}

{
  "error": {
    "code": "insufficient_credits",
    "message": "Insufficient credits."
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Forbidden."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Not found."
  }
}

{
  "error": {
    "code": "idempotency_duplicate",
    "message": "Duplicate idempotency key."
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded."
  }
}

{
  "error": {
    "code": "unknown_error",
    "message": "An unknown error occurred."
  }
}