Skip to navigation

Create a new asset

Beta

Create a new asset such as a spreadsheet, document, folder, database, computer, user interface, skill, collab agent, figure, Word document, presentation, or generic doc (admin-only) in your workspace with your current permissions. Computer assets return 202 after durable submission, which commits the asset and initialization delivery intent together. Runtime provisioning continues asynchronously. Inspect the returned asset ID for progress instead of repeating creation. Computers accept the same configuration as the Athena UI’s creation dialog: template, provider, cpu, memory (GiB), disk (GiB) and env_vars. Sizes must be offered by the environment’s computer resource policy, and only admins may pick a size other than the template default (403 otherwise). In capability enforce mode, computer creation requires computer.create and returns 403 when denied. Databases accept suspend_timeout_seconds, the auto-suspend window from the database’s Settings in Athena: 0 keeps the database running (it never suspends, and keeps using capacity), otherwise 60 to 86400 seconds. A database is provisioned in the background: poll GET /api/v0/databases/{asset_id}/compute-status until it reports running or suspended. Figures take figure_config, a FigureSpec (kind, rendered and provenance, plus spec or chart), validated as the Athena UI’s figures are. A word_document is a Word document holding Athena’s default template, and a presentation is a blank widescreen PPTX Studio deck (the workspace’s default template is not applied): Athena creates each with its own studio credential, as your write, and answers once the studio has seeded it (502, keeping nothing, when PPTX Studio could not seed a deck). Edit them through DOCX Studio or PPTX Studio with a token from POST /api/v0/assets/{asset_id}/studio-token. From an agent run (a verified X-Athena-Session-Credential), their first write also records the run, and a presentation takes the create_presentation_pptx_studio tool policy. Without workspace_id the asset is created in the workspace of parent_folder_id when one is given, otherwise in your current workspace; you must be a member of that workspace.

Authentication

X-API-KEYstring
API Key authentication via header

Headers

X-Athena-Session-CredentialstringOptional

Request

This endpoint expects an object.
asset_typeenumRequired

Type of asset to create. Supported types: ‘spreadsheet’ (or ‘sheet’), ‘document’ (or ‘doc’), ‘folder’, ‘database’ (or ‘db’), ‘computer’, ‘generic_doc’, ‘user_interface’ (or ‘ui’), ‘skill’, ‘collab_agent’ (or ‘agent’), ‘figure’, ‘word_document’ (or ‘word’), ‘presentation’ (or ‘deck’). ‘document’ is Athena’s rich-text document; a Word document is ‘word_document’.

agent_configobject or nullOptional

collab_agent only. Initial agent configuration. Created as a draft; publish it with POST /api/v0/assets/{asset_id}/publish.

cpuinteger or nullOptional>=1

Computer only. vCPU count. Defaults to the template’s default. Must be a size the environment’s computer resource policy offers; sizes other than the template default require an admin.

diskinteger or nullOptional>=1
Computer only. Disk size in GiB. Defaults to the template's default. Same policy and admin rules as cpu.
env_varsmap from strings to strings or nullOptional
Computer only. Environment variables to set on the computer. Must include every key the template or environment requires. Also accepted as 'envVars'.
figure_configobject or nullOptional

figure only. The figure’s FigureSpec: kind, rendered and provenance, plus spec (plotly, vega-lite) or chart (chart, mixed) and the optional fields.

html_contentstring or nullOptional

user_interface only. HTML used as the interface’s initial index.html; without it the interface starts from Athena’s starter page.

memoryinteger or nullOptional>=1
Computer only. Memory in GiB. Defaults to the template's default. Same policy and admin rules as cpu.
parent_folder_idstring or nullOptional
ID of the parent folder to create the asset in
providerstring or nullOptional

Computer only. Runtime provider for the computer (e.g. ‘talos_v2’). Defaults to the environment’s configured computer provider.

skill_configobject or nullOptional

skill only. The skill’s SKILL.md content. Created as a draft; publish it with POST /api/v0/assets/{asset_id}/publish.

suspend_timeout_secondsinteger or nullOptional0-86400

Database only. Seconds without activity after which the database suspends (scales to zero): 0 means it never suspends (the compute keeps running, and keeps using capacity), otherwise 60 to 86400 (24 hours). Defaults to 1800 (30 minutes). Applied while the database is provisioned; if it cannot be applied, the database is not created and compute-status reports failed. Read or change it later with GET/PATCH /api/v0/databases/{asset_id}/settings.

templatestring or nullOptional

Computer only. Template key to create the computer from, as picked in the Athena UI’s computer creation dialog (e.g. ‘default’), or an ‘environment:<asset_id>’ reference to a saved environment. Defaults to the default template. Also accepted as ‘snapshot’.

titlestring or nullOptional
Title for the new asset
workspace_idstring or nullOptional

ID of the workspace to create the asset in. If not provided, the asset is created in the workspace of parent_folder_id when one is given, otherwise in the user’s current workspace. The user must be a member of that workspace.

Response

Asset created successfully
asset_idstring
ID of the newly created asset
asset_typestring
Type of the created asset
created_atstring
Timestamp when the asset was created
titlestring
Title of the created asset
parent_folder_idstring or nullOptional
ID of the parent folder
workspace_idstring or nullOptional
ID of the workspace that owns the created asset

Errors

400
Bad Request Error
403
Forbidden Error
410
Gone Error
422
Unprocessable Entity Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error