Get Processed Data

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
client.download(
    data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851",
    dest_dir="processed/",
    data_type="processed",
)

import requests

response = requests.get(
    "https://api.atomscale.ai/data_entries/processed_data/d290f1ee-6c54-4b01-90e6-d701748f0851",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={"return_as": "url-download"}
)
processed = response.json()

curl "https://api.atomscale.ai/data_entries/processed_data/d290f1ee-6c54-4b01-90e6-d701748f0851?return_as=url-download" \
  -H "X-API-KEY: YOUR_API_KEY"

{
  "url": "https://storage.atomscale.ai/processed/d290f1ee.json?token=...",
  "file_name": "rheed_results.json",
  "file_format": "json",
  "metadata": {}
}

GET

data_entries

processed_data

{data_id}

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
client.download(
    data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851",
    dest_dir="processed/",
    data_type="processed",
)

import requests

response = requests.get(
    "https://api.atomscale.ai/data_entries/processed_data/d290f1ee-6c54-4b01-90e6-d701748f0851",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={"return_as": "url-download"}
)
processed = response.json()

curl "https://api.atomscale.ai/data_entries/processed_data/d290f1ee-6c54-4b01-90e6-d701748f0851?return_as=url-download" \
  -H "X-API-KEY: YOUR_API_KEY"

{
  "url": "https://storage.atomscale.ai/processed/d290f1ee.json?token=...",
  "file_name": "rheed_results.json",
  "file_format": "json",
  "metadata": {}
}

Returns processed data for a data entry. You must specify how you want the data returned using the return_as parameter.

string

required

The UUID of the data entry

string

required

How to return the data: bytes (raw binary), url-download (pre-signed download URL), or url-embed (pre-signed embeddable URL)

string

default:"none"

Filter type: video to retrieve processed video, or none

boolean

default:"false"

Set to true when retrieving processed data for a streaming session

string

Optional suffix to append to the processed data file path

Response

When return_as is url-download or url-embed:

string

Pre-signed URL for accessing the processed data file

string

Filename of the processed data

string

File format/extension

object

Additional metadata about the processed data

Returns null if no processed data is available yet.

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
client.download(
    data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851",
    dest_dir="processed/",
    data_type="processed",
)

import requests

response = requests.get(
    "https://api.atomscale.ai/data_entries/processed_data/d290f1ee-6c54-4b01-90e6-d701748f0851",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={"return_as": "url-download"}
)
processed = response.json()

curl "https://api.atomscale.ai/data_entries/processed_data/d290f1ee-6c54-4b01-90e6-d701748f0851?return_as=url-download" \
  -H "X-API-KEY: YOUR_API_KEY"

{
  "url": "https://storage.atomscale.ai/processed/d290f1ee.json?token=...",
  "file_name": "rheed_results.json",
  "file_format": "json",
  "metadata": {}
}

Introduction

Data Catalogue

Data Upload

Projects

Physical Samples

RHEED

SEM

Spectroscopy

OES

SIMS

Optical

Metrology

Tags

Target Materials

Instruments

Response

​Response

Response