Returns a descriptive caption generated for a 3D asset.

Accepted Asset File Formats:

  • .3DS
  • .FBX
  • .GLB
  • .GLTF
  • .MAX
  • .OBJ
  • .OFF
  • .PLY
  • .STL
  • .USDZ

or a .ZIP file with exactly one asset file of one of the above formats.

Adding Textures:

Textures/Materials are important for caption accuracy, and so care must be taken to ensure that they are either:

  1. Embedded within the single asset file
  2. Referenced by relative path in the asset file. If your asset uses separate (ie. non-embedded) texture files you must first ZIP up the folder containing the asset file and textures.

Hint: As a rule of thumb, if your asset's textures correctly load in Blender, then they will correctly load in the API.

You can check whether textures have been applied properly by looking at the rendered image of your asset in the API Dashboard

Body Params
uri
length ≥ 1

A (public or presigned) HTTPS URL link to the 3D Asset file to be captioned. Provide either a URL or a file, not both.

file

The 3D Asset file to be captioned. Provide either a URL or a file, not both.

Responses

Response body
object
string
required
string
required

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json