Schemas

AccessLogEntry

One request the workspace made, as the access log recorded it.

log_id

string · uuid

log_timestamp

string · date-time

log_user

string

log_api_key

string

log_level

string

log_method

string

log_url

string

log_params

string

log_query

string

log_body

string

log_user_name

string

Agent

An AI agent: the prompt it answers from, the model it runs on, and the tools and knowledge it may reach for.

agent_id

string · uuid

agent_name

string

agent_description

string

agent_icon

string

agent_model

string

agent_temperature

number

agent_top_p

string

agent_audience

string

agent_ds

string

agent_system_prompt

string

agent_config

object

agent_tools

string

agent_conns

string

agent_metadata

object

agent_managed_by

string

agent_active

boolean

agent_created

string · date-time

agent_updated

string · date-time

agent_tenant_id

string · uuid

agent_tenant_enabled

boolean

agent_tenant_ds

string

agent_tenant_instructions

string

agent_tenant_metadata

object

AuditEvent

One change to one record: who made it, when, and what changed.

history_id

string · uuid

history_timestamp

string · date-time

history_user

string

history_record

string

history_table

string

history_op

string

history_ref

string

history_changeset

string

history_user_name

string

BusinessObject

A record the workspace keeps about a thing — a product, a venue, a course. Its attributes are defined by the form `obj_form` names, not by fixed columns.

obj_id

string · uuid

obj_active

boolean

obj_created

string · date-time

obj_updated

string · date-time

obj_created_by

string

obj_type

string

obj_key

string

obj_name

string

obj_form

string

obj_content

object

obj_state_item

string

obj_repo

string

obj_metadata

object

CalendarEvent

A dated event on the workspace's social calendar, with what the workspace decided about it.

ce_id

string · uuid

ce_summary

string

ce_description

string

ce_location

string

ce_start

string · date

ce_end

string · date

ce_source

string · enum

Enum values:

system

feed

custom

ce_hidden

boolean

ce_template

string · uuid

ce_template_name

string

ChatWidget

An embeddable chat widget: the agent behind it, where it may be embedded, and how it looks.

widget_id

string · uuid

widget_active

boolean

widget_created

string · date-time

widget_updated

string · date-time

widget_created_by

string

widget_key

string

widget_name

string

widget_agent

string

widget_origins

string

widget_welcome

string

widget_theme

string

widget_config

object

widget_limits

string

ChatWidgetSession

One visitor's conversation with an embedded chat widget, and whatever it captured about them.

wses_id

string · uuid

wses_active

boolean

wses_created

string · date-time

wses_updated

string · date-time

wses_widget

string

wses_thread

string

wses_user_agent

string

wses_origin

string

wses_page_url

string

wses_country

string

wses_message_count

integer

wses_credits

number

wses_lead

string

wses_metadata

object

wses_first_message

string | null

The visitor's opening message, cut to 300 characters. Null when the visitor never wrote.

wses_feedback_down

integer

How many answers in the conversation the visitor rated not helpful.

Comment

A comment on a record, optionally anchored to one part of it, and its replies.

cmt_id

string · uuid

cmt_created

string · date-time

cmt_updated

string · date-time

cmt_entity_type

string

cmt_entity

string · uuid

cmt_field_path

array | null

Field keys and array indices addressing one part of the record, from its root. Null means the record as a whole.

cmt_parent

string

cmt_user

string

cmt_body

string

object[]

Users named in the body, as the directory spells them.

cmt_resolved_at

string · date-time

cmt_resolved_by

string

cmt_author

object

Who wrote it — enough to attribute and draw an avatar without a second request.

cmt_resolved_by_name

string | null

Display name of whoever resolved the thread. Null while it is open.

ContentApprovalFlow

The review steps a website page moves through before it can be published — what each step is called, and who may move a page into it.

sm_id

string · uuid

sm_active

boolean

sm_created

string · date-time

sm_updated

string · date-time

sm_name

string

sm_default

boolean

The flow governing every site that has not chosen one of its own. At most one flow is the default.

object[]

Retired for content flows: pages move by selecting a step directly, gated by the step's own si_roles.enter. Old definitions may still carry authored moves here; nothing reads them.

sm_metadata

object

object[]

The flow's steps, in the order pages move through them.

ContentSchema

The field shape a page type is generated into: a component name and the fields it holds.

tpl_id

string · uuid

tpl_active

boolean

tpl_created

string · date-time

tpl_updated

string · date-time

tpl_group

string

tpl_name

string

tpl_component

string

tpl_nestable

string

tpl_fields

string

tpl_metadata

object

Design

Editable multi-layer artwork: the canvas its layers sit on, and the preview rendered from them.

de_id

string · uuid

de_created

string · date-time

de_updated

string · date-time

de_user

string

de_name

string

de_description

string

de_type

string

de_template

string

de_categories

string

de_canvas_width

string

de_canvas_height

string

de_canvas_unit

string

de_canvas_dpi

string

de_canvas_background

string

de_preview_file

string

de_export_settings

object

de_metadata

object

de_version

string

preview_file

object

DesignCategory

One term in the workspace's design taxonomy. A product-shipped term (`cat_managed_by` set) is shared and cannot be renamed by the workspace.

cat_id

string · uuid

cat_created

string · date-time

cat_updated

string · date-time

cat_managed_by

string

cat_name

string

cat_order

integer

cat_icon

string

cat_metadata

object

usage_count

integer

How many designs are filed under it.

DesignLayer

One element on a design's canvas — text, an image, a shape or a group — with where it sits and how it looks.

dl_id

string · uuid

dl_created

string · date-time

dl_updated

string · date-time

dl_parent

string

dl_name

string

dl_type

string

dl_order

integer

dl_locked

boolean

dl_visible

boolean

dl_opacity

string

dl_position

string

dl_size

integer

dl_rotation

string

dl_scale

string

dl_flip

string

dl_content

object

dl_style

string

dl_constraints

string

dl_metadata

object

DesignVersion

One saved snapshot of a design, as the version timeline lists it.

de_id

string · uuid

de_name

string

de_created

string · date-time

de_version

string

de_metadata

object

de_canvas_width

string

de_canvas_height

string

de_canvas_unit

string

de_canvas_dpi

string

de_preview_file

string

preview_file

object

layer_count

integer

Document

A document in the library: the file itself, the folders it sits in, and the summary written for it when it was uploaded.

FileRepo

What the file belongs to. One key naming the owning object, or library for a library it sits in rather than an object it belongs to. Keys the platform stamps (presentation jobs, form submissions, workflow runs) are returned but cannot be sent.

file_id

string · uuid

file_name

string

file_type

string

file_size

integer

file_created

string · date-time

file_updated

string · date-time

file_added_by

string

file_hash

string

file_metadata

object

file_replicas

string

file_status

string

file_bucket

string

file_folder

string

file_provider_id

string · uuid

file_summary

string

file_pref

object

object[]

file_deprecated

object

file_relation_count

integer

How many other documents this one is linked to.

markdown_ready

boolean

similarity

number

DocumentRelation

A typed link between two documents, read from one document's side: the type, which way it runs, and the document on the other end.

rel_id

string · uuid

rel_type

string

rel_created

string · date-time

rel_created_by

string

rel_metadata

object

direction

string · enum

from when this document is the one the type's label describes, to when it is the one pointed at.

Enum values:

from

label

string

The type's label as it reads from this document.

relation_type

object

The relationship type: rt_id, rt_name, rt_inverse_name, rt_symmetric.

document

object

The document on the other end: file_id, file_name, file_type, file_size, file_updated, file_deprecated.

ErrorCode

string · enum

Enum values:

bad_request

malformed_json

malformed_body

unsupported_encoding

unsupported_charset

request_aborted

payload_too_large

validation_failed

The closed vocabulary of error codes. Branch on this rather than on title or detail.

ExtensionInstall

An extension as this workspace has it: whether it is offered, enabled or disabled, and the scopes an administrator granted it.

inst_id

string · uuid

inst_status

string

inst_version

string

inst_scopes

string

inst_created

string · date-time

inst_updated

string · date-time

ext_slug

string

The extension the install is of.

ext_name

string

ext_description

string | null

ExtensionStateDocument

One JSON document an extension keeps in the workspace, under a key it chooses.

exs_id

string · uuid

exs_key

string

exs_value

string

exs_version

string

exs_created

string · date-time

exs_updated

string · date-time

exs_updated_by

string

Face

A face detected in a photo, and the person it was matched to if it has been.

fd_id

string · uuid

fd_file

string

fd_person

string

fd_confidence

number

fd_match_distance

string

fd_assigned_at

string · date-time

fd_thumbnail

string

fd_box

string

fd_metadata

object

fd_age

string

fd_gender

string

fd_gender_confidence

number

fd_expression

string

fd_expression_confidence

number

fd_sharpness

string

fd_created

string · date-time

fd_low_quality

boolean

fp_id

string · uuid

fp_name

string

FaceSuggestion

An unassigned face the matcher believes belongs to a person already known.

fd_id

string · uuid

fd_file

string

fd_thumbnail

string

fd_confidence

number

fd_created

string · date-time

fd_gender

string

fd_gender_confidence

number

fd_age

string

suggest_verify

object

suggested_distance

number

fp_id

string · uuid

fp_name

string

person_thumbnail

string

person_gender

string

person_age

number

file_id

string · uuid

file_name

string

file_type

string

file_replicas

object

file_bucket

string

file_folder

string

file_provider_id

string

file_created

string · date-time

File

Anything stored in the workspace: what it is, where its bytes sit, and what is known about it.

FileRepo

file_id

string · uuid

file_name

string

file_type

string

file_size

integer

file_created

string · date-time

file_updated

string · date-time

file_metadata

object

file_provider_id

string · uuid

file_bucket

string

file_folder

string

file_hash

string

file_status

string

file_added_by

string

file_replicas

string

file_summary

string

file_pref

object

FileRepo

What the file belongs to. One key naming the owning object, or `library` for a library it sits in rather than an object it belongs to. Keys the platform stamps (presentation jobs, form submissions, workflow runs) are returned but cannot be sent.

library

string[]

A library rather than an object: media is the shared media library, docs is the document library, and generated is what the platform produced without filing it anywhere else.

Enum values:

media

generated

docs

ds

string · uuid

A knowledge base. Its files are the documents it indexes.

thread

string · uuid

A conversation. Its files are the attachments sent to it and the images generated in it.

design

string · uuid

A design. Its files are the assets placed on it and the previews rendered from it.

prompt

string · uuid

A saved prompt. Its files are the references attached to it.

ppt

string · uuid · readOnly

The presentation job that generated this file.

ppt_template

string · uuid · readOnly

The presentation template this file belongs to — the uploaded master deck or a layout background extracted from it.

form

string · uuid · readOnly

The form whose submission carried this file.

submission

string · uuid · readOnly

The form submission this file was uploaded with.

field

string · readOnly

The form field this file was uploaded into.

infographic

string · uuid · readOnly

The rendered infographic this file was derived from.

sitemap

string · uuid · readOnly

The site whose page content this reference file was written for.

node

string · uuid · readOnly

The site page this reference file was written for.

wf_instance

string · uuid · readOnly

The workflow run that generated this file.

wf_name

string · readOnly

The name of the workflow that generated this file.

FileVersion

A copy of a file that a later save replaced.

fv_id

string · uuid

fv_created

string · date-time

fv_master

string

fv_reason

string

fv_size

integer

fv_type

string

fv_hash

string

fv_replicas

string

fv_metadata

object

fv_added_by

string

fv_name

string

fv_added_by_name

string

GeoRestriction

A named set of countries that published assets are blocked from reaching.

geo_id

string · uuid

geo_name

string

geo_workspace_wide

string

geo_source

string

geo_active

boolean

geo_created

string · date-time

geo_updated

string · date-time

geo_countries

string[]

geo_usage

integer

Infographic

A generated data graphic: the image, and the HTML it was rendered from.

file_id

string · uuid

file_name

string

file_type

string

file_size

integer

file_created

string · date-time

file_updated

string · date-time

file_added_by

string

file_repo

string

file_hash

string

file_metadata

object

file_replicas

string

file_provider_id

string · uuid

file_bucket

string

file_folder

string

file_pref

object

version_count

integer

Integration

A connection to a third-party product, and the state of that connection.

conn_id

string · uuid

conn_active

boolean

conn_created

string · date-time

conn_updated

string · date-time

conn_name

string

conn_provider

string

conn_status

string

conn_config

object

conn_provider_params

string

conn_metadata

object

KnowledgeBase

A set of records agents retrieve from.

ds_id

string · uuid

ds_name

string

ds_description

string

ds_type

string

ds_category

string

ds_subcategory

string

ds_config

object

ds_metadata

object

ds_active

boolean

ds_created

string · date-time

ds_updated

string · date-time

form_id

string · uuid

The knowledge base's record schema — see GET /knowledge-base-schemas/{id}. Null unless the base is form-backed.

form_name

string

form_managed_by

string · uuid

KnowledgeBaseRecord

One record in a knowledge base, shaped by the form its base was created with.

data_id

string · uuid

data_title

string

data_repo

string

data_content

object

data_form

string

data_metadata

object

data_active

boolean

data_created

string · date-time

data_updated

string · date-time

data_excerpt

string

KnowledgeBaseSchema

The record shape of a form-backed knowledge base. Product-shipped schemas are the standard templates a new base starts from; a fork copies one into the workspace.

form_id

string · uuid

form_name

string

form_description

string

form_config

object

form_metadata

object

form_managed_by

string

form_active

boolean

form_created

string · date-time

form_updated

string · date-time

MediaAnalysisSchema

Fields the workspace adds to media analysis — what the vision model extracts from every analyzed image, over and above the built-in analysis.

form_id

string · uuid

form_name

string

form_description

string

form_config

object

form_metadata

object

form_managed_by

string

form_active

boolean

form_created

string · date-time

form_updated

string · date-time

MediaFile

A file as the media library lists it: the file itself, the albums it sits in, and — when the request searched by image or by face — how close the match was.

FileRepo

file_id

string · uuid

file_name

string

file_type

string

file_size

integer

file_created

string · date-time

file_updated

string · date-time

file_added_by

string

file_hash

string

file_metadata

object

file_replicas

string

file_status

string

file_bucket

string

file_folder

string

file_provider_id

string · uuid

file_state_item

string

file_pref

object

object[]

similarity

number

face_similarity

number

MediaStatusFlow

The statuses media moves through before the whole workspace sees it — who sees an item in each status, and who may move it on.

sm_id

string · uuid

sm_active

boolean

sm_created

string · date-time

sm_updated

string · date-time

sm_object_criteria

object

object[]

The moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.

sm_metadata

object

object[]

The flow's statuses, in display order.

Memory

Something the assistant remembers about the calling user.

mem_id

string · uuid

mem_value

string

mem_type

string

mem_source

string

mem_thread

string

mem_active

boolean

mem_metadata

object

mem_created

string · date-time

mem_updated

string · date-time

Message

One message in a thread — what was said, by whom, and what it cost.

msg_id

string · uuid

msg_thread

string

msg_parent

string

msg_sequence

string

msg_role

string

msg_content

object

msg_sender

string

msg_model

string

msg_metadata

object

msg_error

string

msg_feedback

string

msg_form

string

msg_version

string

msg_edited_at

string · date-time

msg_tool_calls

string

msg_tool_call_id

string · uuid

msg_created

string · date-time

msg_active

boolean

ObjectLifecycleFlow

The states the workspace's records move through — who sees a record in each state, and who may move it on.

sm_id

string · uuid

sm_active

boolean

sm_created

string · date-time

sm_updated

string · date-time

sm_object_criteria

object

object[]

sm_metadata

object

object[]

The flow's states, in display order.

ObjectRelation

A typed, directional link between two things — one object and another, a file and an object, or an object and a classification node.

rel_id

string · uuid

rel_active

boolean

rel_created

string · date-time

rel_created_by

string

rel_type

string

rel_from

string

rel_from_type

string

rel_to

string

rel_to_type

string

rel_metadata

object

ObjectSchema

The attributes one kind of object has. Objects naming it in `obj_form` store their values against these fields.

form_id

string · uuid

form_name

string

form_description

string

form_config

object

form_metadata

object

form_managed_by

string

form_active

boolean

form_created

string · date-time

form_updated

string · date-time

ObjectSource

A connection to an upstream system records are pulled from, with the mapping that turns its data into objects. Secrets in `src_config` read back masked.

src_id

string · uuid

src_active

boolean

src_created

string · date-time

src_updated

string · date-time

src_created_by

string

src_name

string

src_provider

string

src_config

object

src_state

string

src_metadata

object

ObjectSyncJob

One run against a source: a full load, a scheduled delta or a retry of an earlier run's failures, with its counts and the records it could not settle.

osj_id

string · uuid

osj_source

string

osj_kind

string

osj_trigger

string

osj_status

string

osj_created

string · date-time

osj_updated

string · date-time

osj_started

string

osj_finished

string

osj_created_by

string

osj_options

string

osj_total

string

osj_done

string

osj_failed

string

osj_result

string

osj_failures

string

osj_error

string

osj_cancel

string

osj_stalled

boolean

Running, but its worker has stopped reporting in. Resume it.

ObjectTaxonomy

One node of a classification scheme. Nodes sharing a `tax_type` form one tree; `tax_parent` is the node above, and a node with none is a root.

tax_id

string · uuid

tax_active

boolean

tax_created

string · date-time

tax_updated

string · date-time

tax_type

string

tax_name

string

tax_key

string

tax_parent

string

tax_order

integer

tax_metadata

object

object_count

integer

How many objects are filed directly under this node.

Page

One page or folder in a site's tree: what it is for, what has been written into it, and how far along that is.

node_id

string · uuid

node_created

string · date-time

node_updated

string · date-time

node_sitemap

string

node_parent

string

node_order

integer

node_type

string · enum

A page holds content and may have pages under it; a folder only holds pages. A page with content cannot become a folder.

Enum values:

page

folder

node_name

string

node_slug

string

node_instructions

string

node_instructions_params

string

node_children_instructions

string

node_component

string

node_content

object

node_content_summary

string

node_content_status

string

node_state_item

string

node_threads

string

node_metadata

object

The page's SEO meta data. Filled by generation from the draft copy and editable; kept out of node_content so it is never pushed to a connected CMS.

object

Reviewer material written alongside the copy: the review agent's account of the page when the site names one (review), and the editor agent's pass when the site names an editor (editor). Kept out of node_content so it never reaches a CMS. Left out of the site tree; read it from one page, or include=review.

node_assignee

string | null · uuid

Who the page currently waits on. Set freely via PUT /sites/{id}/pages/{page_id}/assignee and carried unchanged through workflow moves unless the move says otherwise.

node_approved_at

string | null · date-time

When the page was last signed off. A page carrying this and standing at draft has been edited since — the copy that was approved is still kept, and GET /sites/{id}/pages/{page_id}/approved-content answers with it.

node_approved_by

string | null · uuid

Who signed it off. Null on pages approved before this was recorded.

node_open_comments

integer

Unresolved comment threads on this page. Only sent when a site is fetched whole.

PageCommentThread

One comment thread on a page, summarized: where it sits, how the conversation stands, and who is in it.

cmt_id

string · uuid

cmt_created

string · date-time

cmt_updated

string · date-time

cmt_entity

string · uuid

The page the thread is on.

cmt_field_path

array | null

Field keys and array indices addressing one part of the page, from its root. Null means the page as a whole.

cmt_user

string

cmt_body

string

object[]

Users named in the body, as the directory spells them.

cmt_resolved_at

string · date-time

cmt_resolved_by

string

cmt_author

object

Who opened the thread — enough to attribute and draw an avatar.

cmt_resolved_by_name

string | null

Display name of whoever resolved the thread. Null while it is open.

cmt_participants

array

Everyone who has spoken in the thread, the opener included.

cmt_reply_count

integer

Replies under the thread, not counting the comment that opened it.

cmt_last_activity

string

When the thread was last added to. A reply is its own row and never touches the first comment, so this is not cmt_updated.

cmt_page

object

The page the thread is on: its id, name, slug, content status, and its place in the tree.

cmt_anchor_label

string | null

What the anchored field is called, read against the page as it stands (Body › Plan with confidence › Text). Null for a thread about the page as a whole.

cmt_anchor_unattached

boolean

True when the anchor no longer resolves — the block it named was moved or removed, and the conversation outlived its subject.

Person

A named identity that faces are grouped into.

fp_id

string · uuid

fp_name

string

fp_cover

string

fp_metadata

object

fp_active

boolean

fp_created

string · date-time

fp_updated

string · date-time

cover_thumbnail

string

face_count

integer

manual_count

integer

suggestion_count

integer

total_count

integer

PersonPhoto

A photo a person appears in: the file, plus the detection that matched them.

file_id

string · uuid

file_name

string

file_type

string

file_size

integer

file_created

string · date-time

file_updated

string · date-time

file_replicas

string

file_metadata

object

file_status

string

file_bucket

string

file_folder

string

file_provider_id

string · uuid

fd_id

string · uuid

fd_thumbnail

string

fd_confidence

number

fd_match_distance

number

fd_box

object

Presentation

A generated deck: its plan, its progress, and the file it produced.

ppt_job_id

string · uuid

ppt_job_created

string · date-time

ppt_job_updated

string · date-time

ppt_job_created_by

string

ppt_job_status

string

ppt_job_progress

string

ppt_job_title

string

ppt_job_params

string

ppt_job_plan

string

ppt_job_output_file_id

string · uuid

ppt_job_error

string

ppt_job_metadata

object

PresentationTemplate

A .pptx file decks are generated into, and the layouts read out of it.

ppt_tpl_id

string · uuid

ppt_tpl_name

string

ppt_tpl_description

string

ppt_tpl_file_id

string · uuid

ppt_tpl_config

object

ppt_tpl_metadata

object

ppt_tpl_active

boolean

ppt_tpl_created

string · date-time

ppt_tpl_updated

string · date-time

file_name

string

file_replicas

string[]

Problem

Every non-2xx response, in the RFC 9457 problem+json shape.

type

string · uri · required

A URI identifying the error kind.

Example: https://docs.genuineai.app/errors/validation-failed

title

string · required

A short, human-readable summary of the error kind.

status

integer · required

The HTTP status code, repeated in the body.

code

ErrorCode · enum · required

The closed vocabulary of error codes. Branch on this rather than on title or detail.

Enum values:

bad_request

malformed_json

malformed_body

unsupported_encoding

unsupported_charset

request_aborted

payload_too_large

validation_failed

detail

string

What went wrong with this specific request.

instance

string

The path that produced the error.

errorId

string

Correlates the response with our logs. Quote it in support requests.

upstreamCode

string

A code minted by a provider we call (Stripe, Vapi). Never one of ours.

object[]

Present on 422. One entry per field that failed validation.

feature

string

Present on license_required. The module the workspace is missing, as named on the operation and in features on GET /me.

Example: module-design

Prompt

A reusable prompt and the inputs it asks for.

prompt_id

string · uuid

prompt_name

string

prompt_description

string

prompt_description_short

string

prompt_icon

string

prompt_agent

string

prompt_author

string

prompt_config

object

prompt_metadata

object

prompt_supported_models

string

prompt_text

string

prompt_wildcards

string

prompt_managed_by

string

prompt_active

boolean

prompt_created

string · date-time

prompt_updated

string · date-time

agent_id

string · uuid

agent_name

string

agent_icon

string

prompt_tenant_id

string · uuid

prompt_tenant_categories

string[]

How this workspace filed the prompt — ids from /prompt-categories. Per workspace, so filing a product prompt affects nobody else.

prompt_tenant_time_savings

integer

last_used

string · date-time

PromptCategory

One term in the workspace's prompt taxonomy. A product-shipped term (`cat_managed_by` set) is shared and cannot be renamed by the workspace.

cat_id

string · uuid

cat_created

string · date-time

cat_updated

string · date-time

cat_managed_by

string

cat_name

string

cat_order

integer

cat_icon

string

cat_metadata

object

usage_count

integer

How many prompts are filed under it.

Publication

An asset released to a permanent public URL, with the distribution rules that govern it.

pub_id

string · uuid

pub_file

string

pub_state

string

pub_version

string

pub_hostname

string

pub_name

string

pub_size

integer

pub_content_type

string

pub_hash

string

pub_start

string · date-time

pub_end

string · date-time

pub_copy_state

string

pub_error

string

pub_deny

string[]

pub_restrictions

string[]

pub_created

string · date-time

pub_updated

string · date-time

pub_published

string

pub_revoked

string

pub_url

string · uri

pub_stale

boolean

pub_file_name

string

pub_published_name

string

RelationType

A relationship type items of a library can be linked with: how it reads from each end and whether it has a direction.

rt_id

string · uuid

rt_active

boolean

rt_created

string · date-time

rt_updated

string · date-time

rt_name

string

rt_inverse_name

string

rt_symmetric

boolean

rt_description

string

Role

A named set of permissions users can hold.

role_id

string · uuid

role_name

string

role_description

string

role_icon

string

role_permissions

string

role_managed_by

string

role_active

boolean

role_created

string · date-time

role_users_count

integer

ScheduledJob

Recurring work the platform runs for the workspace, and when it next runs.

job_id

string · uuid

job_managed_by

string

job_active

boolean

job_created

string · date-time

job_updated

string · date-time

job_name

string

job_title

string

job_description

string

job_cron

string

job_timezone

string

job_type

string

job_workflow

string

job_config

object

job_scope

string

job_max_retries

string

job_timeout_seconds

string

job_metadata

object

override_id

string · uuid

override_enabled

boolean

override_cron

string

override_timezone

string

override_config

object

last_run_status

string

last_run_at

string · date-time

SecurityEvent

One authentication event on an account — a sign-in attempt, a credential change, or a second-factor action.

ae_id

string · uuid

ae_timestamp

string · date-time

ae_user

string · uuid

ae_type

string

ae_success

boolean

ae_ip

string

ae_user_agent

string

ae_city

string

ae_country

string

ae_connection

string

ae_client_name

string

ae_user_name

string

ShareLink

A link that publishes files outward, or accepts them inward, without an account.

share_id

string · uuid

share_name

string

share_type

string

share_active

boolean

share_created

string · date-time

share_updated

string · date-time

share_created_by

string

share_expires_at

string · date-time

share_file_ids

string

share_album_id

string · uuid

share_options

string

share_view_count

integer

share_download_count

integer

share_max_files

string

share_max_size

integer

share_created_by_name

string

share_file_count

integer

share_upload_count

integer

share_last_upload_at

string · date-time

share_password_set

boolean

share_pre_tags

string[]

share_album_ids

string[]

share_allow_change_tags

boolean

share_allow_change_albums

boolean

kiosk_url

string · uri

Site

A website whose page tree and content the platform drafts, fills and keeps in step with a CMS.

sitemap_id

string · uuid

sitemap_created

string · date-time

sitemap_updated

string · date-time

sitemap_user

string

sitemap_name

string

sitemap_domain

string

sitemap_description

string

sitemap_config

object

sitemap_metadata

object

sitemap_tpl_group

string

sitemap_approval_mode

string · enum

How the site is reviewed: the workspace's default approval flow, the one sitemap_approval_flow names, or not at all. Set through PUT /sites/{id}/approval-flow.

Enum values:

default

flow

none

sitemap_approval_flow

string | null · uuid

The approval flow the site chose; only read when sitemap_approval_mode is flow.

sitemap_last_edited

string · date-time

The later of sitemap_updated and the last change to any of the site's pages. Only sent by the list.

SocialPost

A post sent to a connected social account, or scheduled to be.

sp_id

string · uuid

sp_file

string

sp_user

string

sp_platform

string

sp_status

string

sp_caption

string

sp_media_type

string

sp_platform_data

string

sp_metadata

object

sp_error

string

sp_scheduled_at

string · date-time

sp_published_at

string · date-time

sp_created

string · date-time

sp_updated

string · date-time

file_name

string

file_type

string

file_replicas

object

Space

A shared home for conversations: who may see it, and what it collects.

space_id

string · uuid

space_active

boolean

space_created

string · date-time

space_updated

string · date-time

space_created_by

string

space_name

string

space_description

string

space_icon

string

space_color

string

space_parent

string

space_default_agent

string

space_system_prompt

string

space_knowledge

string

space_metadata

object

thread_count

integer

child_count

integer

Task

A work item: what is being asked, who owns it, and where it has got to in review.

task_id

string · uuid

task_number

integer

task_name

string

task_description

string

task_status

string

task_priority

string

task_assigned_to

string

task_assigned_at

string · date-time

task_created_by

string

task_due_at

string · date-time

task_form

string

task_data

string

task_copilot

string

task_wf

string

task_wf_instance

string

task_wf_step

string

task_callback_url

string

task_is_template

string

task_active

boolean

task_created

string · date-time

task_updated

string · date-time

Thread

One conversation — the agent answering it, what it is about, and where it is filed.

thread_id

string · uuid

thread_title

string

thread_type

string

thread_status

string

thread_summary

string

thread_context

string

thread_ref

string

thread_agent

string

thread_user

string

thread_space

string

thread_share_mode

string

thread_generating_for

string

thread_metadata

object

thread_active

boolean

thread_created

string · date-time

thread_updated

string · date-time

agent_id

string · uuid

agent_name

string

agent_icon

string

agent_active

boolean

prompt_id

string · uuid

prompt_name

string

UploadTarget

A file record awaiting its bytes, with the signed URL to PUT them to — or, when the file was refused, why.

file_id

string · uuid

file_name

string

file_type

string

file_size

integer

file_created

string · date-time

file_status

string

file_repo

string

file_metadata

object

file_bucket

string

file_folder

string

file_provider_id

string · uuid

uploadUrl

string · uri

PUT the bytes here, then finalize the file. Absent on a rejected file.

rejection_reason

string

Why this file was not accepted. Absent on an accepted one.

UsageEntry

One metered action and what it consumed.

usage_id

string · uuid

usage_timestamp

string · date-time

usage_user

string

usage_param

string

usage_details

string

usage_consumed_units

string

usage_consumed_credits

number

usage_cost_id

string · uuid

User

A person in the workspace.

usr_id

string · uuid

usr_email

string

usr_created

string · date-time

usr_active

boolean

usr_name_first

string

usr_name_last

string

usr_lang

string

usr_theme

string

usr_name

string

external_user

boolean

memb_picture

string

memb_active

boolean

memb_roles

string[]

memb_permissions

string[]

memb_settings

object

memb_last_login

string · date-time

memb_attr

object

VoiceAgent

An AI agent that answers a phone number, and the number it answers on.

vag_id

string · uuid

vag_active

boolean

vag_created

string · date-time

vag_updated

string · date-time

vag_created_by

string

vag_key

string

vag_name

string

vag_agent

string

vag_config

object

vag_limits

string

vag_provider_ref

string

VoiceCall

One call a voice agent took: who called, how it ended, and what was said.

vcall_id

string · uuid

vcall_created

string · date-time

vcall_type

string

vcall_from

string

vcall_to

string

vcall_status

string

vcall_ended_reason

string

vcall_started

string

vcall_ended

string

vcall_duration_seconds

string

vcall_credits

number

vcall_summary

string

vcall_analysis

string

vcall_has_recording

boolean

vcall_has_transcript

boolean

Wildcard

A named input a prompt asks for, and how it is collected.

wildcard_id

string · uuid

wildcard_name

string

wildcard_description

string

wildcard_control_type

string

wildcard_control_props

string

wildcard_metadata

object

wildcard_managed_by

string

wildcard_active

boolean

wildcard_created

string · date-time

wildcard_updated

string · date-time

Workflow

A multi-step process: what it does, what starts it, and whether it is deployed.

wf_id

string · uuid

wf_name

string

wf_title

string

wf_description

string

wf_version

string

wf_trigger

string

wf_status

string

wf_provider

string

wf_managed_by

string

wf_active

boolean

wf_created

string · date-time

wf_updated

string · date-time

WorkflowInstance

One run of a workflow: where it got to, and what it is waiting on.

wi_id

string · uuid

wi_workflow

string

wi_status

string

wi_provider

string

wi_provider_id

string · uuid

wi_state

string

wi_error

string

wi_initiated_by

string

wi_created

string · date-time

wi_updated

string · date-time

wf_name

string

Name of the workflow this instance runs.