Raw data
Get image file
Get a sample as an image file. This only applies to samples with RGBA data.
get/api/{projectId}/raw-data/{sampleId}/image
Request
- Base URLhttps://studio.edgeimpulse.com/v1
- Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2Authorization code/v1/oauth/authorizeClient credentialsImplicit/v1/oauth/authorizePasswordToken URL/v1/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
projectIdinteger required
Project ID
sampleIdinteger required
Sample ID
Query parameters
afterInputBlockboolean
Whether to process the image through the input block first
cacheKeystring
If set, then a long cache header is sent. If this is omitted then a no-cache header is sent. You can use this if you f.e. know the last modified date of a sample. Stick the last modified date in the cache key, so the sample can be stored in browser cache (and will automatically be invalidated if the modified date changes).
impulseIdinteger
Impulse ID. If this is unset then the default impulse is used.
datastreamIndexinteger
Datastream index (defaults to 0)
datasetVersionIdinteger
Dataset version ID. If not set, the current mutable dataset is used
Response
Image file (either JPEG or PNG format)
Changes
No recorded changes to this operation across all 1 revision of this API.