Skip to main content
POST
/
target-materials
/
curl -X POST "https://api.atomscale.ai/target-materials/" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sample": {
      "sample_name": "BaTiO3 on Si",
      "substrate": "Si"
    },
    "layers": [
      {
        "layer_id": 1,
        "composition_string": "BaTiO3",
        "orientation": "001"
      }
    ]
  }'

{
  "sample_id": 42,
  "sample_name": "BaTiO3 on Si",
  "substrate": "Si",
  "sample_metadata": {},
  "detail_notes_id": null,
  "user_id": "user_abc123",
  "version": "0.269.1",
  "last_updated": "2024-01-15T11:00:00Z"
}
Creates a new target material. A target material is the intended layer stack and substrate for a sample. Provide the sample details and, optionally, the layers that make up the stack.
​
sample
object
required
Details of the target material sample.
​
layers
array
Array of layer definitions that make up the stack. Each layer can include composition_string, layer_id, orientation, space_group, mp_id, and element_dict.

​
Response

​
sample_id
integer
ID of the created target material sample
​
sample_name
string
Name of the target material sample
​
substrate
string
Substrate the layers are grown on
​
sample_metadata
object
Metadata attached to the sample
​
detail_notes_id
string
ID of the linked detail note, if any
​
user_id
string
ID of the user who created the record
​
version
string
Schema version of the record
​
last_updated
string
ISO 8601 timestamp of the last update
curl -X POST "https://api.atomscale.ai/target-materials/" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sample": {
      "sample_name": "BaTiO3 on Si",
      "substrate": "Si"
    },
    "layers": [
      {
        "layer_id": 1,
        "composition_string": "BaTiO3",
        "orientation": "001"
      }
    ]
  }'

{
  "sample_id": 42,
  "sample_name": "BaTiO3 on Si",
  "substrate": "Si",
  "sample_metadata": {},
  "detail_notes_id": null,
  "user_id": "user_abc123",
  "version": "0.269.1",
  "last_updated": "2024-01-15T11:00:00Z"
}