curl "$ATAI_API_URL/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e" \
-H "Authorization: Bearer $ATAI_API_KEY"
import os
import requests
base_url = os.environ["ATAI_API_URL"]
api_key = os.environ["ATAI_API_KEY"]
response = requests.get(
f"{base_url}/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
headers={"Authorization": f"Bearer {api_key}"},
)
if response.status_code == 200:
project = response.json()
print(f"{project['name']} ({project['id']}), created by {project['created_by']}")
else:
print(f"Error: {response.json()['errors']}")
const response = await fetch(
`${process.env.ATAI_API_URL}/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e`,
{
headers: {
'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
}
}
);
const body = await response.json();
if (response.ok) {
console.log(`${body.name} (${body.id}), created by ${body.created_by}`);
} else {
console.error('Error:', body.errors);
}
{
"id": "prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
"name": "Line 3 pump monitoring",
"description": "Rare-event detection for the line 3 pumps.",
"created_by": "usr_01jc7x2n5k8vq3m6t9r4hdzb1s",
"created_at": "2026-10-28T09:12:44Z",
"updated_at": "2026-10-28T09:12:44Z"
}
{
"errors": [
{
"code": "<error_code>",
"message": "Project not found.",
"suggestion": null,
"error_uid": "err-xxxxxxxx"
}
]
}
Projects API
Get Project
Retrieve a single project by id
GET
/
api
/
projects
/
{project_id}
curl "$ATAI_API_URL/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e" \
-H "Authorization: Bearer $ATAI_API_KEY"
import os
import requests
base_url = os.environ["ATAI_API_URL"]
api_key = os.environ["ATAI_API_KEY"]
response = requests.get(
f"{base_url}/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
headers={"Authorization": f"Bearer {api_key}"},
)
if response.status_code == 200:
project = response.json()
print(f"{project['name']} ({project['id']}), created by {project['created_by']}")
else:
print(f"Error: {response.json()['errors']}")
const response = await fetch(
`${process.env.ATAI_API_URL}/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e`,
{
headers: {
'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
}
}
);
const body = await response.json();
if (response.ok) {
console.log(`${body.name} (${body.id}), created by ${body.created_by}`);
} else {
console.error('Error:', body.errors);
}
{
"id": "prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
"name": "Line 3 pump monitoring",
"description": "Rare-event detection for the line 3 pumps.",
"created_by": "usr_01jc7x2n5k8vq3m6t9r4hdzb1s",
"created_at": "2026-10-28T09:12:44Z",
"updated_at": "2026-10-28T09:12:44Z"
}
{
"errors": [
{
"code": "<error_code>",
"message": "Project not found.",
"suggestion": null,
"error_uid": "err-xxxxxxxx"
}
]
}
Requires version 2.0.0 or later of the Archetype platform.
Overview
This endpoint returns one project, addressed by itsprj_ id.
Request
string
required
Project
prj_ ID.Response
string
required
The project’s
prj_ id.string
required
Display name.
string
required
Description; empty when none was given.
string
required
Who created the project: a user’s
usr_ id, or the key_ id of the service-account API key it
was created with. Never changes.string
required
When the project was created (date-time).
string
required
When the project’s name or description last changed (date-time); its creation time until then.
curl "$ATAI_API_URL/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e" \
-H "Authorization: Bearer $ATAI_API_KEY"
import os
import requests
base_url = os.environ["ATAI_API_URL"]
api_key = os.environ["ATAI_API_KEY"]
response = requests.get(
f"{base_url}/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
headers={"Authorization": f"Bearer {api_key}"},
)
if response.status_code == 200:
project = response.json()
print(f"{project['name']} ({project['id']}), created by {project['created_by']}")
else:
print(f"Error: {response.json()['errors']}")
const response = await fetch(
`${process.env.ATAI_API_URL}/api/projects/prj_01jcd4m8t2vq6xn3r7k5hbzw9e`,
{
headers: {
'Authorization': `Bearer ${process.env.ATAI_API_KEY}`
}
}
);
const body = await response.json();
if (response.ok) {
console.log(`${body.name} (${body.id}), created by ${body.created_by}`);
} else {
console.error('Error:', body.errors);
}
{
"id": "prj_01jcd4m8t2vq6xn3r7k5hbzw9e",
"name": "Line 3 pump monitoring",
"description": "Rare-event detection for the line 3 pumps.",
"created_by": "usr_01jc7x2n5k8vq3m6t9r4hdzb1s",
"created_at": "2026-10-28T09:12:44Z",
"updated_at": "2026-10-28T09:12:44Z"
}
{
"errors": [
{
"code": "<error_code>",
"message": "Project not found.",
"suggestion": null,
"error_uid": "err-xxxxxxxx"
}
]
}
Important Notes
- A
404means the project does not exist or is not visible to you. A project is visible to its creator and to the organization’s admins; one created with a service-account API key is visible to every service-account key of the organization.
Was this page helpful?