Enjin

Checks a request sent with send_request or export_model: queued, running, completed, failed or cancelled. For a completed export it gives a download link that works for 60 seconds; call again for a fresh one. Where the Enjin export card is shown, do not write that link as a button or link: point the person to the card's Download button, which makes a fresh link at each tap. While it is queued or running, wait the check_again_in_seconds it gives (about a minute) before checking again, and tell the person it is still working.

request_status

Creates a new, empty Enjin study with a title. Then use send_request on it to build the first model.

create_study

For the export card only: an export's current state and, once it is ready, a short-lived link to download the file.

export_file

Exports the study's latest revision as a Revit (.rvt) or Rhino (.3dm) file. Exports use no credits. Shows the Enjin export card, which follows the export by itself and gives the person a Download button when it is ready, so there is no need to keep checking. Where no card is shown, call request_status about once a minute until it is completed to get the download link.

export_model

Lists the signed-in person's Enjin studies, newest first, with each study's id, title and last update. Use it to find the study to read.

list_studies

Shows the study's current model as pictures you can look at: one sheet with four 3/4 views from above (top row) and four elevations (bottom row), or one view at full size. They are flat-shaded views of the 3D model, not drawings: use them to check shape, massing and what sits where, and take sizes and levels from read_study measurements, not from the pictures. Free.

view_model

For the model card only: a short-lived link to one version's 3D model file, to show it in 3D.

model_file

Reads one Enjin study: its title, its revisions (newest first, with each one's parameters) and its recent requests, plus measurements of the current model: overall size and height in metres, and each layer's object count and height range (bottom and top), which show the floor levels. Judge a model from these measurements, not from a reply's wording. Also gives the current version's named rooms (rooms: each room's name, level, programme, area and target area in m², outline in metres, and which rooms are next to or open into which, with totals: count, total area, area per level, per programme, and per programme on each level with its target area) and its levels (name and elevation in metres). Take room counts and areas only from rooms, never from a reply's wording; if rooms is null, the note says why. If measurements say measuring, nothing is measured yet: never call any size or level measured or verified, and read again in a minute. Gives a link to open the study in Enjin.

read_study

Sends one design request to a study, as if typed in Enjin: the first request builds a model, later ones revise the latest revision (earlier revisions are kept). Spends the person's Enjin credits, which cannot be undone, so confirm with them first. Ask for one change per request; several changes in one request can run out of time. The request takes minutes: call request_status with the returned request_id until it is completed, then check the result with read_study measurements, not from the reply's wording.

send_request