Skip to content

Public API reference

Every public REST endpoint, grouped by path. The machine-readable document is openapi.json.

All routes live under https://platform.merofoundry.com/api/v1/public/ and take an application API key in the X-API-Key header unless the description says otherwise.

/api/v1/public/app/{app_slug}/forms/{form_id}/render

Section titled “/api/v1/public/app/{app_slug}/forms/{form_id}/render”

Operation id: render_public_form_by_slug_api_v1_public_app__app_slug__forms__form_id__render_get

Render Public Form By Slug

Parameters:

[
{
"in": "path",
"name": "app_slug",
"required": true,
"schema": {
"title": "App Slug",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenderFormResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/app/{app_slug}/forms/{form_id}/submit

Section titled “/api/v1/public/app/{app_slug}/forms/{form_id}/submit”

Operation id: submit_public_form_by_slug_api_v1_public_app__app_slug__forms__form_id__submit_post

Submit Public Form By Slug

Parameters:

[
{
"in": "path",
"name": "app_slug",
"required": true,
"schema": {
"title": "App Slug",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitFormResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: render_public_home_page_api_v1_public_app__app_slug__home_get

Render Public Home Page

Parameters:

[
{
"in": "path",
"name": "app_slug",
"required": true,
"schema": {
"title": "App Slug",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenderPageResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/app/{app_slug}/{page_path}/render

Section titled “/api/v1/public/app/{app_slug}/{page_path}/render”

Operation id: render_public_page_by_path_api_v1_public_app__app_slug___page_path__render_get

Render Public Page By Path

Parameters:

[
{
"in": "path",
"name": "app_slug",
"required": true,
"schema": {
"title": "App Slug",
"type": "string"
}
},
{
"in": "path",
"name": "page_path",
"required": true,
"schema": {
"title": "Page Path",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenderPageResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: listApplications

Lists applications in the workspace of the API key or platform OAuth grant, or only the bound application of an OAuth grant narrowed to one application. This is a workspace-scoped operation with no application_id path parameter. Requires the app:read permission.

Parameters:

[
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ApplicationResponse"
},
"title": "Response Listapplications",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createApplication

Creates a new application scoped to the workspace of the API key or workspace OAuth grant. This is a workspace-scoped operation — the credential does not need to belong to an existing application. Requires the applications:create permission.

Parameters:

[
{
"in": "header",
"name": "Idempotency-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Idempotency-Key"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{app_id}/pages/{page_id}/render

Section titled “/api/v1/public/applications/{app_id}/pages/{page_id}/render”

Operation id: render_public_page_api_v1_public_applications__app_id__pages__page_id__render_get

Render Public Page

Parameters:

[
{
"in": "path",
"name": "app_id",
"required": true,
"schema": {
"format": "uuid",
"title": "App Id",
"type": "string"
}
},
{
"in": "path",
"name": "page_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Page Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenderPageResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}

Section titled “/api/v1/public/applications/{application_id}”

Operation id: getApplication

Returns metadata for the application identified by application_id, including its name, slug, tenant, and workspace. Requires the app:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateApplication

Partially updates the application identified by application_id. The application must be the one the API key is scoped to. sitePreviewPublic makes the hosted-site preview host public; it is private to signed-in platform users by default. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteApplication

Archives the application identified by application_id, setting its status to ‘archived’. The application must be the one the API key is scoped to. Returns 204 No Content on success. Requires the applications:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/audit/events

Section titled “/api/v1/public/applications/{application_id}/audit/events”

Operation id: listAuditEvents

Lists audit events for the application identified by application_id. Requires the audit:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "actor_type",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Actor Type"
}
},
{
"in": "query",
"name": "actor_id",
"required": false,
"schema": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Actor Id"
}
},
{
"in": "query",
"name": "action",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Action"
}
},
{
"in": "query",
"name": "date_from",
"required": false,
"schema": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Date From"
}
},
{
"in": "query",
"name": "date_to",
"required": false,
"schema": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Date To"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"title": "Offset",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AuditEventResponse"
},
"title": "Response Listauditevents",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/capabilities

Section titled “/api/v1/public/applications/{application_id}/capabilities”

Operation id: getApplicationCapabilities

Returns the capabilities the runtime enforces for the application. Only entries with overridable set to true may be enabled through update_application body.capabilities. This route stays available while public_api is disabled so the state can be read; public_api itself cannot be enabled through update_application while it is disabled and must be changed in the application’s settings in the console. Requires the app:read permission. Applications outside the caller’s scope return 404.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationCapabilitiesResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/composites

Section titled “/api/v1/public/applications/{application_id}/composites”

Operation id: listComposites

Returns composites scoped to the authenticated application. Requires the pages:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicCompositeListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createComposites

Creates a new composites for the application. Requires the pages:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicCompositeResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/composites/{composite_id}

Section titled “/api/v1/public/applications/{application_id}/composites/{composite_id}”

Operation id: getComposites

Returns the composites identified by composite_id. It must belong to the current application. Requires the pages:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "composite_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Composite Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicCompositeResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateComposites

Updates the composites identified by composite_id. It must belong to the current application. Requires the pages:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "composite_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Composite Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicCompositeResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteComposites

Deletes the composites identified by composite_id. It must belong to the current application. Returns 204 No Content on success. Requires the pages:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "composite_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Composite Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/domains

Section titled “/api/v1/public/applications/{application_id}/domains”

Operation id: listDomain

Returns domains scoped to the authenticated application. Requires the domains:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createDomain

Creates a new domain for the application. Requires the domains:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/domains/{domain_id}

Section titled “/api/v1/public/applications/{application_id}/domains/{domain_id}”

Operation id: getDomain

Returns the domain identified by domain_id. It must belong to the current application. Requires the domains:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "domain_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Domain Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteDomain

Deletes the domain identified by domain_id. It must belong to the current application. Returns 204 No Content on success. Requires the domains:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "domain_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Domain Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/domains/{domain_id}/bind

Section titled “/api/v1/public/applications/{application_id}/domains/{domain_id}/bind”

Operation id: bindDomain

Activates routing for a verified domain owned by this application. Requires the domains:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "domain_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Domain Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/domains/{domain_id}/issue

Section titled “/api/v1/public/applications/{application_id}/domains/{domain_id}/issue”

Operation id: issueDomainCertificate

Issues a certificate for a verified domain owned by this application. Requires the domains:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "domain_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Domain Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/domains/{domain_id}/verification/check

Section titled “/api/v1/public/applications/{application_id}/domains/{domain_id}/verification/check”

Operation id: checkDomainVerification

Checks the application domain’s verification TXT record. Requires the domains:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "domain_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Domain Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainVerificationStatusResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/domains/{domain_id}/verification/start

Section titled “/api/v1/public/applications/{application_id}/domains/{domain_id}/verification/start”

Operation id: startDomainVerification

Returns the DNS TXT record required to verify a domain owned by this application. Requires the domains:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "domain_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Domain Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DomainVerificationStartResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/export

Section titled “/api/v1/public/applications/{application_id}/export”

Operation id: exportApplicationBundle

Stream the API-key-bound application’s portable archive.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/zip": {}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/fields/{field_id}

Section titled “/api/v1/public/applications/{application_id}/fields/{field_id}”

Operation id: getFieldById

Returns a field belonging to the current application. Requires fields:read.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "field_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Field Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/files

Section titled “/api/v1/public/applications/{application_id}/files”

Operation id: listFiles

Lists files belonging to the current application. Set include_deleted=true to include soft-deleted files. Requires the files:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "include_deleted",
"required": false,
"schema": {
"default": false,
"title": "Include Deleted",
"type": "boolean"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/files/ticket-upload

Section titled “/api/v1/public/applications/{application_id}/files/ticket-upload”

Operation id: uploadFileWithTicket

Uploads one binary file (multipart/form-data, exactly one field named file) with a file upload ticket from the hosted MCP create_file_upload_ticket tool, presented as Authorization: Bearer. No other credential is accepted. The file must have exactly the SHA-256 and byte count the ticket declares. The ticket’s OAuth grant must still hold the files:upload permission. The first upload returns 201 with the file metadata and no download link; an identical retry returns 200 with the same file. File size, content type and storage limits are enforced as for uploadFile.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
}
]

Responses:

{
"200": {
"description": "An identical retry with the same ticket: the file its first upload stored. Nothing new is stored."
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileTicketUploadResponse"
}
}
},
"description": "Successful Response"
},
"409": {
"description": "`site_upload_in_progress`: another request is uploading with this ticket; retry after `Retry-After`."
},
"410": {
"description": "`site_upload_result_gone`: the file this ticket stored was deleted; request a new ticket."
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/files/upload

Section titled “/api/v1/public/applications/{application_id}/files/upload”

Operation id: uploadFile

Uploads a binary file (multipart/form-data, field name file) for the application. Returns file metadata including a short-lived presigned download URL. File size and storage limits are enforced via entitlements. Requires the files:upload permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUploadResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/files/{file_id}

Section titled “/api/v1/public/applications/{application_id}/files/{file_id}”

Operation id: getFile

Returns metadata for the file identified by file_id, including content type, size, status, custom metadata, and a short-lived presigned download URL. The file must belong to the current application, or be a platform file the application binds as a static asset. Requires the files:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"format": "uuid",
"title": "File Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileDetailResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteFile

Soft-deletes the file metadata record and removes the object from storage. The file must belong to the current application. Returns 204 No Content on success. Requires the files:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"format": "uuid",
"title": "File Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/files/{file_id}/content

Section titled “/api/v1/public/applications/{application_id}/files/{file_id}/content”

Operation id: updateFileContent

Replaces the bytes of an existing file (multipart/form-data, field name file) while keeping its id, name and every reference to it. The part’s content type becomes the file’s declared type, under the same size, type and SVG rules as an upload. Only growth is checked against the storage entitlement. The file must belong to the current application, or be a platform file the application binds as a static asset, and must not be deleted. Requires the files:upload permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"format": "uuid",
"title": "File Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileDetailResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/files/{file_id}/download

Section titled “/api/v1/public/applications/{application_id}/files/{file_id}/download”

Operation id: downloadFile

Streams the raw binary content of the file identified by file_id. Responds with a safe content type and a Content-Disposition: attachment header. The file must belong to the current application, or be a platform file the application binds as a static asset. Requires the files:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"format": "uuid",
"title": "File Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/files/{file_id}/restore

Section titled “/api/v1/public/applications/{application_id}/files/{file_id}/restore”

Operation id: restoreFile

Restores a soft-deleted file that belongs to the current application. Requires the files:restore permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"format": "uuid",
"title": "File Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileDetailResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/forms

Section titled “/api/v1/public/applications/{application_id}/forms”

Operation id: listForm

Returns forms scoped to the authenticated application. Requires the forms:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createForm

Creates a new form for the application. Requires the forms:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/forms/{form_id}

Section titled “/api/v1/public/applications/{application_id}/forms/{form_id}”

Operation id: getForm

Returns the form identified by form_id. It must belong to the current application. Requires the forms:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateForm

Updates the form identified by form_id. It must belong to the current application. Requires the forms:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteForm

Deletes the form identified by form_id. It must belong to the current application. Returns 204 No Content on success. Requires the forms:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/forms/{form_id}/components

Section titled “/api/v1/public/applications/{application_id}/forms/{form_id}/components”

Operation id: addFormComponent

Adds a composite component to the form. Requires the forms:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormComponentResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/forms/{form_id}/components/reorder

Section titled “/api/v1/public/applications/{application_id}/forms/{form_id}/components/reorder”

Operation id: reorderFormComponents

Applies the complete component ordering supplied in the request. Requires the forms:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormComponentListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/forms/{form_id}/components/{form_component_id}

Section titled “/api/v1/public/applications/{application_id}/forms/{form_id}/components/{form_component_id}”

Operation id: removeFormComponent

Permanently removes a component from the form. Requires the forms:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "path",
"name": "form_component_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Component Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/forms/{form_id}/render

Section titled “/api/v1/public/applications/{application_id}/forms/{form_id}/render”

Operation id: render_public_form_api_v1_public_applications__application_id__forms__form_id__render_post

Render Public Form

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "form_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Form Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenderFormResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/functions

Section titled “/api/v1/public/applications/{application_id}/functions”

Operation id: listFunction

Returns functions scoped to the authenticated application. Requires the functions:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FunctionListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createFunction

Creates a new function for the application. Requires the functions:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FunctionResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/functions/{function_id}

Section titled “/api/v1/public/applications/{application_id}/functions/{function_id}”

Operation id: getFunction

Returns the function identified by function_id. It must belong to the current application. Requires the functions:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "function_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Function Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FunctionResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateFunction

Updates the function identified by function_id. It must belong to the current application. Requires the functions:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "function_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Function Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FunctionResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteFunction

Deletes the function identified by function_id. It must belong to the current application. Returns 204 No Content on success. Requires the functions:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "function_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Function Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/import

Section titled “/api/v1/public/applications/{application_id}/import”

Operation id: restoreApplicationBundle

Restore an archive into the API-key-bound application when it is empty.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Restoreapplicationbundle",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/jobs

Section titled “/api/v1/public/applications/{application_id}/jobs”

Operation id: listScheduledJob

Returns jobs scoped to the authenticated application. Requires the jobs:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicScheduledJobListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createScheduledJob

Creates a new scheduledjob for the application. Requires the jobs:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicScheduledJobResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/jobs/{job_id}

Section titled “/api/v1/public/applications/{application_id}/jobs/{job_id}”

Operation id: getScheduledJob

Returns the scheduledjob identified by job_id. It must belong to the current application. Requires the jobs:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Job Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicScheduledJobResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateScheduledJob

Updates the scheduledjob identified by job_id. It must belong to the current application. Requires the jobs:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Job Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicScheduledJobResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteScheduledJob

Deletes the scheduledjob identified by job_id. It must belong to the current application. Returns 204 No Content on success. Requires the jobs:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Job Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/jobs/{job_id}/executions

Section titled “/api/v1/public/applications/{application_id}/jobs/{job_id}/executions”

Operation id: listJobExecutions

Returns execution history for the scheduled job identified by job_id. It must belong to the current application. Requires the jobs:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Job Id",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicJobExecutionListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/jobs/{job_id}/run

Section titled “/api/v1/public/applications/{application_id}/jobs/{job_id}/run”

Operation id: runScheduledJob

Executes the scheduled job identified by job_id right now, outside its cron schedule. It must belong to the current application. Requires the jobs:execute permission and the automation_integration capability.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Job Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicJobExecutionResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models

Section titled “/api/v1/public/applications/{application_id}/models”

Operation id: listModel

Returns models scoped to the authenticated application. Requires the models:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "view",
"required": false,
"schema": {
"default": "published",
"pattern": "^(draft|published)$",
"title": "View",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ModelResponse"
},
"title": "Response Listmodel",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createModel

Creates a new model for the application. Requires the models:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelDetailResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}”

Operation id: getModel

Returns the model identified by model_id. It must belong to the current application. Requires the models:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "query",
"name": "view",
"required": false,
"schema": {
"default": "published",
"pattern": "^(draft|published)$",
"title": "View",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelDetailResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateModel

Updates the model identified by model_id. It must belong to the current application. Requires the models:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelDetailResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteModel

Deletes the model identified by model_id. It must belong to the current application. Returns 204 No Content on success. Requires the models:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/audit

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/audit”

Operation id: getModelAudit

Returns the audit trail for the model identified by model_id. The model must belong to the application the API key is scoped to. Requires the audit:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/RecordAuditLogResponse"
},
"title": "Response Getmodelaudit",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/fields

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/fields”

Operation id: listField

Returns fields scoped to the authenticated application. Requires the fields:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "query",
"name": "view",
"required": false,
"schema": {
"default": "published",
"pattern": "^(draft|published)$",
"title": "View",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/FieldResponse"
},
"title": "Response Listfield",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createField

Creates a new field for the application. Requires the fields:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/fields/{field_id}

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/fields/{field_id}”

Operation id: getField

Returns the field identified by field_id. It must belong to the current application. Requires the fields:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "path",
"name": "field_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Field Id",
"type": "string"
}
},
{
"in": "query",
"name": "view",
"required": false,
"schema": {
"default": "published",
"pattern": "^(draft|published)$",
"title": "View",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateField

Updates the field identified by field_id. It must belong to the current application. Requires the fields:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "path",
"name": "field_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Field Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FieldResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteField

Deletes the field identified by field_id. It must belong to the current application. Returns 204 No Content on success. Requires the fields:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "path",
"name": "field_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Field Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/forms

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/forms”

Operation id: listModelForms

Lists forms bound to the specified model within the application. Requires the forms:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createModelForm

Creates a new form bound to the specified model. The model must belong to the specified application. Requires the forms:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/publish

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/publish”

Operation id: publishModel

Publishes the current draft schema version of the model, making it available on the public API. The model must belong to the specified application. Requires the models:publish permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/records

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/records”

Operation id: listRecord

Returns records scoped to the authenticated application. Requires the records:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"minimum": 1,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "per_page",
"required": false,
"schema": {
"default": 25,
"maximum": 100,
"minimum": 1,
"title": "Per Page",
"type": "integer"
}
},
{
"in": "query",
"name": "sort",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sort"
}
},
{
"in": "query",
"name": "order",
"required": false,
"schema": {
"default": "asc",
"pattern": "^(asc|desc)$",
"title": "Order",
"type": "string"
}
},
{
"in": "query",
"name": "resolve_references",
"required": false,
"schema": {
"default": false,
"title": "Resolve References",
"type": "boolean"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createRecord

Creates a new record for the application. Requires the records:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/records/reorder

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/records/reorder”

Operation id: reorderRecords

Applies a complete ordering to the model’s records in one operation; a bad id fails the whole batch and leaves the order unchanged. Requires the records:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReorderRecordsResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/records/search

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/records/search”

Operation id: searchRecords

Returns records ranked by cosine similarity against a published public-API vector field. Only public-API fields from the published schema are returned, and vector field values are never returned. Requires the records:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRecordsResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/records/{record_id}

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/records/{record_id}”

Operation id: getRecord

Returns the record identified by record_id. It must belong to the current application. Requires the records:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateRecord

Updates the record identified by record_id. It must belong to the current application. Requires the records:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteRecord

Deletes the record identified by record_id. It must belong to the current application. Returns 204 No Content on success. Requires the records:delete permission. An application identity is not deleted in place: returns 202 with its erasure job.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"202": {
"description": "An application identity is not deleted in place: returns 202 with its erasure job."
},
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/scaffold-services

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/scaffold-services”

POST Scaffold guarded CRUD services for a model

Section titled “POST Scaffold guarded CRUD services for a model”

Operation id: scaffoldModelServices

Creates the guarded list/get/create/update/delete services and their ownership saved queries for a model, scoped by the given ownership query and owner field. Idempotent: existing services are reported, not recreated. Requires services:configure and the automation_integration capability.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScaffoldModelServicesResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/models/{model_id}/stats

Section titled “/api/v1/public/applications/{application_id}/models/{model_id}/stats”

Operation id: getModelStats

Returns aggregate stats for records in the model. Use aggregation=count|sum|avg|min|max, fieldName for field-based aggregations, and additional query parameters as equality filters. Requires the models:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "query",
"name": "aggregation",
"required": false,
"schema": {
"default": "count",
"title": "Aggregation",
"type": "string"
}
},
{
"in": "query",
"name": "fieldName",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fieldname"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatsResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/notifications

Section titled “/api/v1/public/applications/{application_id}/notifications”

Operation id: listNotification

Returns notifications scoped to the authenticated application. Requires the notifications:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicNotificationListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createNotification

Creates a new notification for the application. Requires the notifications:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicNotificationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/notifications/{notification_id}

Section titled “/api/v1/public/applications/{application_id}/notifications/{notification_id}”

Operation id: getNotification

Returns the notification identified by notification_id. It must belong to the current application. Requires the notifications:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "notification_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Notification Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicNotificationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateNotification

Updates the notification identified by notification_id. It must belong to the current application. Requires the notifications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "notification_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Notification Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicNotificationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteNotification

Deletes the notification identified by notification_id. It must belong to the current application. Returns 204 No Content on success. Requires the notifications:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "notification_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Notification Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/notifications/{notification_id}/logs

Section titled “/api/v1/public/applications/{application_id}/notifications/{notification_id}/logs”

Operation id: listNotificationLogs

Returns delivery logs for the notification identified by notification_id. It must belong to the current application. Requires the notifications:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "notification_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Notification Id",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicNotificationLogListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/notifications/{notification_id}/send

Section titled “/api/v1/public/applications/{application_id}/notifications/{notification_id}/send”

Operation id: sendNotification

Sends the notification identified by notification_id using the supplied context. It must belong to the current application. Requires the notifications:execute permission and the automation_integration capability.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "notification_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Notification Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicSendNotificationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/outbound-destination-governance

Section titled “/api/v1/public/applications/{application_id}/outbound-destination-governance”

PUT Update outbound destination governance

Section titled “PUT Update outbound destination governance”

Operation id: updateOutboundDestinationGovernance

Updates service/webhook outbound destination allow-list governance. Requires a hosted-MCP OAuth grant carrying risky:outbound_destinations:configure.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutboundDestinationGovernanceResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/outbound-sender

Section titled “/api/v1/public/applications/{application_id}/outbound-sender”

Operation id: getOutboundSender

Hosted-MCP OAuth only. Returns metadata only, never SMTP credentials.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutboundSenderStatusResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: setOutboundSender

Hosted-MCP OAuth only. SMTP passwords are write-only and never returned.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutboundSenderStatusResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteOutboundSender

Hosted-MCP OAuth only. Disables the configured sender.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/outbound-sender/test

Section titled “/api/v1/public/applications/{application_id}/outbound-sender/test”

Operation id: testOutboundSender

Hosted-MCP OAuth only. Sends a test email using the stored SMTP credential.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutboundSenderTestResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/pages

Section titled “/api/v1/public/applications/{application_id}/pages”

Operation id: listPage

Returns pages scoped to the authenticated application. Requires the pages:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPageListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createPage

Creates a new page for the application. Requires the pages:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPageResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/pages/{page_id}

Section titled “/api/v1/public/applications/{application_id}/pages/{page_id}”

Operation id: getPage

Returns the page identified by page_id. It must belong to the current application. Requires the pages:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "page_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Page Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPageResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updatePage

Updates the page identified by page_id. It must belong to the current application. Requires the pages:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "page_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Page Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicPageResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deletePage

Deletes the page identified by page_id. It must belong to the current application. Returns 204 No Content on success. Requires the pages:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "page_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Page Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/pages/{page_id}/published

Section titled “/api/v1/public/applications/{application_id}/pages/{page_id}/published”

Operation id: getPublishedPage

Returns the rendered, published version of the page — the same rendering an unauthenticated visitor of the published application would receive. Both the application and the page must be published. Requires the pages:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "page_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Page Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicRenderPageResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/pages/{page_id}/render

Section titled “/api/v1/public/applications/{application_id}/pages/{page_id}/render”

Operation id: renderPage

Renders the page’s layout (composites expanded, style resolved), matching the admin authoring preview. Works regardless of the page’s publish status. Requires the pages:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "page_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Page Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicRenderPageResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/problems

Section titled “/api/v1/public/applications/{application_id}/problems”

Operation id: listProblems

Lists the application’s failures of the last 30 days, newest first: request failures, failed rule runs, job executions, notifications, webhook deliveries and service calls. Filters apply before the limit; continue with cursor. Requires the audit:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"description": "Only this failure source: request, rule, job, notification, webhook, service.",
"in": "query",
"name": "kind",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Only this failure source: request, rule, job, notification, webhook, service.",
"title": "Kind"
}
},
{
"description": "Exact visitor reference code of one request failure.",
"in": "query",
"name": "reference",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Exact visitor reference code of one request failure.",
"title": "Reference"
}
},
{
"description": "Only failures of items attached to this model; excludes entries without a model, including every service failure.",
"in": "query",
"name": "model_id",
"required": false,
"schema": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"description": "Only failures of items attached to this model; excludes entries without a model, including every service failure.",
"title": "Model Id"
}
},
{
"description": "nextCursor of the previous page, with the same filters.",
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "nextCursor of the previous page, with the same filters.",
"title": "Cursor"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/push-credentials

Section titled “/api/v1/public/applications/{application_id}/push-credentials”

Operation id: getPushCredentials

Hosted-MCP OAuth only. Metadata and active registration counts; never a key, service account or device token. Available only while the application’s mobile_distribution capability resolves enabled.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCredentialsStatusResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/push-credentials/apns

Section titled “/api/v1/public/applications/{application_id}/push-credentials/apns”

Operation id: setApnsPushCredentials

Hosted-MCP OAuth only. The .p8 private_key is write-only and never returned; bundle_id and team_id must match an ios mobile_apps entry. Available only while the application’s mobile_distribution capability resolves enabled.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApnsPushCredentialStatusResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/push-credentials/fcm

Section titled “/api/v1/public/applications/{application_id}/push-credentials/fcm”

Operation id: setFcmPushCredentials

Hosted-MCP OAuth only. service_account_json is write-only and never returned. Available only while the application’s mobile_distribution capability resolves enabled.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FcmPushCredentialStatusResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/push-credentials/{platform}

Section titled “/api/v1/public/applications/{application_id}/push-credentials/{platform}”

Operation id: deletePushCredentials

Hosted-MCP OAuth only. Deletes the platform’s credential. Available only while the application’s mobile_distribution capability resolves enabled.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "platform",
"required": true,
"schema": {
"$ref": "#/components/schemas/PushPlatform"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/push-credentials/{platform}/test

Section titled “/api/v1/public/applications/{application_id}/push-credentials/{platform}/test”

Operation id: testPushCredentials

Hosted-MCP OAuth only. Sends a silent push to one active registration of this application and platform, named by its id. Available only while the application’s mobile_distribution capability resolves enabled.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "platform",
"required": true,
"schema": {
"$ref": "#/components/schemas/PushPlatform"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushCredentialsTestResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/push/devices

Section titled “/api/v1/public/applications/{application_id}/push/devices”

PUT Register or refresh the calling consumer’s push device

Section titled “PUT Register or refresh the calling consumer’s push device”

Operation id: registerPushDevice

Insert the token, or re-bind it to the caller and refresh it; never answer the token.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PushDeviceRegistrationResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/push/devices/{token}

Section titled “/api/v1/public/applications/{application_id}/push/devices/{token}”

DELETE Remove the calling consumer’s push device

Section titled “DELETE Remove the calling consumer’s push device”

Operation id: unregisterPushDevice

Remove the caller’s registration of the token; 204 whether or not there was one.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "token",
"required": true,
"schema": {
"maxLength": 4096,
"minLength": 1,
"title": "Token",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/queries

Section titled “/api/v1/public/applications/{application_id}/queries”

Operation id: executeQuery

Executes an ad-hoc QueryAST against records in the requested application and returns columns, rows, and total row count. This API-key route uses admin execution semantics, so public saved-query field allow-lists and public row caps do not apply. Requires the records:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResultResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/records/{record_id}/audit

Section titled “/api/v1/public/applications/{application_id}/records/{record_id}/audit”

Operation id: getRecordAudit

Returns the audit trail for the record identified by record_id. The record must belong to the application the API key is scoped to. Requires the audit:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/RecordAuditLogResponse"
},
"title": "Response Getrecordaudit",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/relationships

Section titled “/api/v1/public/applications/{application_id}/relationships”

Operation id: listRelationship

Returns relationships scoped to the authenticated application. Requires the relationships:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicRelationshipListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createRelationship

Creates a new relationship for the application. Requires the relationships:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicRelationshipResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/relationships/derive

Section titled “/api/v1/public/applications/{application_id}/relationships/derive”

POST Derive relationships from reference fields

Section titled “POST Derive relationships from reference fields”

Operation id: deriveRelationships

Scans the application’s models for reference-type fields and creates forward/reverse relationships for any that don’t already exist. Requires the relationships:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicDeriveRelationshipsResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/relationships/{relationship_id}

Section titled “/api/v1/public/applications/{application_id}/relationships/{relationship_id}”

Operation id: getRelationship

Returns the relationship identified by relationship_id. It must belong to the current application. Requires the relationships:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "relationship_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Relationship Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicRelationshipResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateRelationship

Updates the relationship identified by relationship_id. It must belong to the current application. Requires the relationships:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "relationship_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Relationship Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicRelationshipResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteRelationship

Deletes the relationship identified by relationship_id. It must belong to the current application. Returns 204 No Content on success. Requires the relationships:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "relationship_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Relationship Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/restore/models/{event_id}

Section titled “/api/v1/public/applications/{application_id}/restore/models/{event_id}”

Operation id: restoreModel

Restores a deleted model, its fields and every record its deletion removed from the model’s snapshot audit event, in one transaction, and returns the restored and skipped record counts, the dropped fields and the ids of restored records whose credentials must be set again. Requires the audit:read, models:create and records:create permissions.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Event Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestoreModelResult"
}
}
},
"description": "Successful Response"
},
"404": {
"description": "The deletion event is missing, expired, scrubbed or out of scope."
},
"409": {
"description": "The model's record batch is incomplete, or an erasure is running."
},
"422": {
"description": "The event cannot be restored as asked, for example because its original id already exists again; the message says why."
}
}

/api/v1/public/applications/{application_id}/restore/records/{event_id}

Section titled “/api/v1/public/applications/{application_id}/restore/records/{event_id}”

Operation id: restoreRecord

Restores the record a record delete audit event names, under its original id, and returns it with the fields that no longer exist in the published schema and the ids of restored records whose credentials must be set again. Requires the audit:read and records:create permissions.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Event Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestoreRecordResult"
}
}
},
"description": "Successful Response"
},
"404": {
"description": "The deletion event is missing, expired, scrubbed or out of scope."
},
"409": {
"description": "The model's record batch is incomplete, or an erasure is running."
},
"422": {
"description": "The event cannot be restored as asked, for example because its original id already exists again; the message says why."
}
}

/api/v1/public/applications/{application_id}/rules

Section titled “/api/v1/public/applications/{application_id}/rules”

Operation id: listRule

Returns rules scoped to the authenticated application. Requires the rules:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "model_id",
"required": false,
"schema": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Id"
}
},
{
"in": "query",
"name": "is_active",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Active"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createRule

Creates a new rule for the application. Requires the rules:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/rules/events

Section titled “/api/v1/public/applications/{application_id}/rules/events”

Operation id: evaluateRuleEvent

Evaluates automation rules for the given event payload. Supply event (arbitrary dict), optional modelId, recordId, and phase (pre_save or post_save; defaults to post_save). Returns matched rule IDs, record update patches, response patches, errors, side effects, queued jobs, and a blocked flag. Requires the rules:execute permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FrontendRuleEventResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/rules/test

Section titled “/api/v1/public/applications/{application_id}/rules/test”

Operation id: testRule

Tests a rule condition and actions against sample data. Requires the rules:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestRuleResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/rules/{rule_id}

Section titled “/api/v1/public/applications/{application_id}/rules/{rule_id}”

Operation id: getRule

Returns the rule identified by rule_id. It must belong to the current application. Requires the rules:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Rule Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateRule

Updates the rule identified by rule_id. It must belong to the current application. Requires the rules:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Rule Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuleResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteRule

Deletes the rule identified by rule_id. It must belong to the current application. Returns 204 No Content on success. Requires the rules:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Rule Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/rules/{rule_id}/logs

Section titled “/api/v1/public/applications/{application_id}/rules/{rule_id}/logs”

Operation id: listRuleLogs

Lists execution logs for a rule scoped to the application. Requires the rules:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Rule Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/RuleLogResponse"
},
"title": "Response Listrulelogs",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/saved-queries

Section titled “/api/v1/public/applications/{application_id}/saved-queries”

Operation id: listSavedQuery

Returns saved-queries scoped to the authenticated application. Requires the queries:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedQueryListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createSavedQuery

Creates a new savedquery for the application. Requires the queries:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedQueryResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/saved-queries/{saved_query_id}

Section titled “/api/v1/public/applications/{application_id}/saved-queries/{saved_query_id}”

Operation id: getSavedQuery

Returns the savedquery identified by saved_query_id. It must belong to the current application. Requires the queries:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "saved_query_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Saved Query Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedQueryResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateSavedQuery

Updates the savedquery identified by saved_query_id. It must belong to the current application. Requires the queries:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "saved_query_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Saved Query Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedQueryResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteSavedQuery

Deletes the savedquery identified by saved_query_id. It must belong to the current application. Returns 204 No Content on success. Requires the queries:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "saved_query_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Saved Query Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/saved-queries/{saved_query_id}/execute

Section titled “/api/v1/public/applications/{application_id}/saved-queries/{saved_query_id}/execute”

Operation id: executeSavedQuery

Executes a stored saved query by id with optional runtime parameters (bound to ‘:param_name’ placeholders in the query’s filter values) and returns the columns, rows, and total row count. The saved query is taken from the path; any query/savedQueryId in the request body is ignored. Requires the queries:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "saved_query_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Saved Query Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResultResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/services

Section titled “/api/v1/public/applications/{application_id}/services”

Operation id: listServices

Lists configured services. Credentials are always masked. Requires services:read.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "isActive",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Isactive"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfigListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createService

Hosted-MCP OAuth only. Stores credentials write-only; requires services:configure.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfigResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/services/{service_id}

Section titled “/api/v1/public/applications/{application_id}/services/{service_id}”

Operation id: getService

Gets one configured service with credentials masked. Requires services:read.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "service_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Service Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfigResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateService

Hosted-MCP OAuth only. Use supplied fields to update; credentials remain write-only.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "service_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Service Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceConfigResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteService

Hosted-MCP OAuth only. Permanently deletes the configuration.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "service_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Service Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/services/{service_id}/invoke/stream

Section titled “/api/v1/public/applications/{application_id}/services/{service_id}/invoke/stream”

Operation id: streamInvokeService

Invokes an existing service configuration and streams upstream bytes to the API-key client without reframing. Service creation and configuration remain admin/authoring operations. Requires the services:execute permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "service_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Service Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/services/{service_id}/logs

Section titled “/api/v1/public/applications/{application_id}/services/{service_id}/logs”

Operation id: listServiceLogs

Lists invocation logs for one configured service. Requires services:read. Readable where automation is not enabled: logs are history.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "service_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Service Id",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/ServiceLogResponse"
},
"title": "Response Listservicelogs",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/services/{service_id}/test

Section titled “/api/v1/public/applications/{application_id}/services/{service_id}/test”

Operation id: testService

Tests a configured service using its stored credential. Requires services:read.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "service_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Service Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TestConnectionResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/site/disable

Section titled “/api/v1/public/applications/{application_id}/site/disable”

Operation id: disableSite

Stop serving the site; versions and the active pointer are kept. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"type": "boolean"
},
"title": "Response Disablesite",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/site/enable

Section titled “/api/v1/public/applications/{application_id}/site/enable”

Operation id: enableSite

Serve the active site version on the application’s host; the application becomes closed to generic consumer routes. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"type": "boolean"
},
"title": "Response Enablesite",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/site/preview

Section titled “/api/v1/public/applications/{application_id}/site/preview”

Operation id: setPreviewSiteVersion

Point the application’s preview host at any retained site version; production is unchanged. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Setpreviewsiteversion",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/site/releases

Section titled “/api/v1/public/applications/{application_id}/site/releases”

Operation id: listSiteReleases

List releases queued from completed GitHub workflow runs, newest first, with their state, failure reason, function snapshot, notes and the site version each produced (null until published, or after that version is deleted). Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/SiteReleaseResponse"
},
"title": "Response Listsitereleases",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/site/repository

Section titled “/api/v1/public/applications/{application_id}/site/repository”

Operation id: getSiteRepository

Return the GitHub repository whose workflow artifacts release this application’s site, with the artifact name and the last run seen. 404 repository_not_connected when none is connected. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteRepositoryResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

PUT Connect a GitHub repository or change its artifact name

Section titled “PUT Connect a GitHub repository or change its artifact name”

Operation id: connectSiteRepository

With selection_token (from the GitHub App setup) and repository_id, connect that repository, replacing any earlier one; the repository must be granted to the installation and the token must belong to the same user and application. A repository another application already connects answers 409 repository_already_connected and changes nothing. Without them, change only artifact_name of the existing connection. artifact_name defaults to merofoundry. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteRepositoryResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: disconnectSiteRepository

Stop releasing from the connected repository. Release history and site versions are kept. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/site/versions

Section titled “/api/v1/public/applications/{application_id}/site/versions”

Operation id: listSiteVersions

List immutable static-site versions as metadata without manifests, newest first. limit (1 to 200, default 50) bounds the window of newest versions, not the response size: an active or preview version older than that window is added, one row for each distinct version, so a response holds at most limit + 2 versions. Read one version’s manifest with getSiteVersion. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"description": "How many of the newest versions to return: an integer from 1 to 200, default 50.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"description": "How many of the newest versions to return: an integer from 1 to 200, default 50.",
"maximum": 200,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/SiteVersionListItem"
},
"title": "Response Listsiteversions",
"type": "array"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: uploadSiteVersion

Validate and store a built dist/ ZIP as an inactive immutable site version; it becomes the preview version and production is unchanged. Send exactly one multipart field named file and no other fields. Requires the applications:update permission, or a site-upload ticket from the hosted MCP create_site_upload_ticket tool presented as Authorization: Bearer. A ticket’s first upload returns 201; an identical retry returns 200 with the same version.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"description": "An identical retry with the same site-upload ticket: the version its first upload created. Nothing new is stored."
},
"201": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Uploadsiteversion",
"type": "object"
}
}
},
"description": "Successful Response"
},
"409": {
"description": "`site_upload_in_progress`: another request is uploading with this ticket; retry after `Retry-After`."
},
"410": {
"description": "`site_upload_result_gone`: the version this ticket created was deleted; request a new ticket."
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/site/versions/{version_id}

Section titled “/api/v1/public/applications/{application_id}/site/versions/{version_id}”

Operation id: getSiteVersion

Read one immutable static-site version of this application with its manifest. A missing version, or one belonging to another application, answers 404. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "version_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Version Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteVersionDetail"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteSiteVersion

Delete a site version and its stored objects; the active version cannot be deleted, and deleting the preview version clears the preview. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "version_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Version Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/site/versions/{version_id}/activate

Section titled “/api/v1/public/applications/{application_id}/site/versions/{version_id}/activate”

Operation id: activateSiteVersion

Point the application at this version; serving still requires the site to be enabled. Requires the applications:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "version_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Version Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Activatesiteversion",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/styles

Section titled “/api/v1/public/applications/{application_id}/styles”

Operation id: listStyle

Returns styles scoped to the authenticated application. Requires the styles:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StyleListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createStyle

Creates a new style for the application. Requires the styles:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StyleResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/styles/resolve

Section titled “/api/v1/public/applications/{application_id}/styles/resolve”

Operation id: resolveStyle

Resolves style CSS variables in the bound application’s workspace. Requires styles:read.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResolveStyleResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/styles/{style_id}

Section titled “/api/v1/public/applications/{application_id}/styles/{style_id}”

Operation id: getStyle

Returns the style identified by style_id. It must belong to the current application. Requires the styles:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "style_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Style Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StyleResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateStyle

Updates the style identified by style_id. It must belong to the current application. Requires the styles:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "style_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Style Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StyleResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteStyle

Deletes the style identified by style_id. It must belong to the current application. Returns 204 No Content on success. Requires the styles:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "style_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Style Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/templates

Section titled “/api/v1/public/applications/{application_id}/templates”

Operation id: listTemplates

Lists templates visible to the bound application’s workspace.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "is_public",
"required": false,
"schema": {
"default": false,
"title": "Is Public",
"type": "boolean"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/templates/export

Section titled “/api/v1/public/applications/{application_id}/templates/export”

Operation id: exportTemplate

Exports the path application as a reusable template; any body applicationId is ignored.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/templates/installations/{installation_id}/upgrade

Section titled “/api/v1/public/applications/{application_id}/templates/installations/{installation_id}/upgrade”

Operation id: previewTemplateUpgrade

Reports whether a template installation in the path application can be upgraded.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "installation_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Installation Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateUpgradeResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: upgradeTemplateInstallation

Applies an available template upgrade to an installation in the path application.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "installation_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Installation Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplyTemplateUpgradeResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/templates/{template_id}

Section titled “/api/v1/public/applications/{application_id}/templates/{template_id}”

Operation id: getTemplate

Returns one workspace-visible or public template and its definition.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Template Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/templates/{template_id}/install

Section titled “/api/v1/public/applications/{application_id}/templates/{template_id}/install”

Operation id: installTemplate

Installs a template into the path application; any body applicationId is ignored.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Template Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallTemplateResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/temporal-preview

Section titled “/api/v1/public/applications/{application_id}/temporal-preview”

Operation id: previewTemporalRecords

Evaluates the application’s temporal rules at a fixed instant and returns the preview. Requires the records:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemporalPreviewResponseSchema"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/traffic

Section titled “/api/v1/public/applications/{application_id}/traffic”

Operation id: getTraffic

Returns the application-scoped traffic summary for the date range. Requires the traffic:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "from",
"required": true,
"schema": {
"format": "date",
"title": "From",
"type": "string"
}
},
{
"in": "query",
"name": "to",
"required": true,
"schema": {
"format": "date",
"title": "To",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrafficSnapshotResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/traffic/export.csv

Section titled “/api/v1/public/applications/{application_id}/traffic/export.csv”

Operation id: exportTrafficCsv

Streams the application-scoped visit events for the date range as CSV. Requires the traffic:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "from",
"required": true,
"schema": {
"format": "date",
"title": "From",
"type": "string"
}
},
{
"in": "query",
"name": "to",
"required": true,
"schema": {
"format": "date",
"title": "To",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/usage

Section titled “/api/v1/public/applications/{application_id}/usage”

Operation id: getUsage

Returns the application-scoped usage dimensions without tenant plan or billing metadata. Requires the traffic:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Getusage",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/virtual-occurrences

Section titled “/api/v1/public/applications/{application_id}/virtual-occurrences”

Operation id: listVirtualOccurrences

Derives the virtual occurrences that fall inside the requested window. Requires the records:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "query",
"name": "window_start",
"required": true,
"schema": {
"format": "date",
"title": "Window Start",
"type": "string"
}
},
{
"in": "query",
"name": "window_end",
"required": true,
"schema": {
"format": "date",
"title": "Window End",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
"title": "Response Listvirtualoccurrences",
"type": "object"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/webhooks

Section titled “/api/v1/public/applications/{application_id}/webhooks”

Operation id: listWebhook

Returns webhooks scoped to the authenticated application. Requires the webhooks:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: createWebhook

Creates a new webhook for the application. Requires the webhooks:create permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/webhooks/{webhook_id}

Section titled “/api/v1/public/applications/{application_id}/webhooks/{webhook_id}”

Operation id: getWebhook

Returns the webhook identified by webhook_id. It must belong to the current application. Requires the webhooks:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "webhook_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Webhook Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: updateWebhook

Updates the webhook identified by webhook_id. It must belong to the current application. Requires the webhooks:update permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "webhook_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Webhook Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: deleteWebhook

Deletes the webhook identified by webhook_id. It must belong to the current application. Returns 204 No Content on success. Requires the webhooks:delete permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "webhook_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Webhook Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/analytics

Section titled “/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/analytics”

Operation id: getWebhookAnalytics

Returns aggregate delivery analytics for the webhook identified by webhook_id. It must belong to the current application. Requires the webhooks:read permission and the automation_integration capability.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "webhook_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Webhook Id",
"type": "string"
}
},
{
"in": "query",
"name": "from",
"required": false,
"schema": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "From"
}
},
{
"in": "query",
"name": "to",
"required": false,
"schema": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "To"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookDeliveryAnalyticsResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/dead-letters

Section titled “/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/dead-letters”

Operation id: listWebhookDeadLetters

Returns failed, non-test deliveries for the webhook identified by webhook_id. It must belong to the current application. Requires the webhooks:read permission and the automation_integration capability.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "webhook_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Webhook Id",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"title": "Limit",
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"title": "Offset",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookDeadLetterListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/deliveries

Section titled “/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/deliveries”

Operation id: listWebhookDeliveries

Returns delivery attempts for the webhook identified by webhook_id. It must belong to the current application. Requires the webhooks:read permission.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "webhook_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Webhook Id",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 50,
"title": "Limit",
"type": "integer"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookDeliveryListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/redeliver/{delivery_id}

Section titled “/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/redeliver/{delivery_id}”

Operation id: redeliverWebhookDelivery

Re-sends a previous delivery’s event/payload to the webhook identified by webhook_id. Both the webhook and the delivery identified by delivery_id must belong to the current application. There is no dedicated redeliver use-case: this fetches the stored delivery and re-runs the same DeliverWebhookUseCase the admin redeliver handler uses, with the delivery’s original event and payload. Requires the webhooks:update permission and the automation_integration capability.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "webhook_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Webhook Id",
"type": "string"
}
},
{
"in": "path",
"name": "delivery_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Delivery Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookDeliveryResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/test

Section titled “/api/v1/public/applications/{application_id}/webhooks/{webhook_id}/test”

Operation id: testWebhook

Sends a test event to the webhook identified by webhook_id. It must belong to the current application. Requires the webhooks:create permission and the automation_integration capability.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "webhook_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Webhook Id",
"type": "string"
}
},
{
"in": "header",
"name": "X-API-Key",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "X-Api-Key"
}
},
{
"in": "header",
"name": "Authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicWebhookDeliveryResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/apps/{application_id}/models/{model_id}/records

Section titled “/api/v1/public/apps/{application_id}/models/{model_id}/records”

Operation id: list_public_records_api_v1_public_apps__application_id__models__model_id__records_get

List Public Records

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 1,
"minimum": 1,
"title": "Page",
"type": "integer"
}
},
{
"in": "query",
"name": "per_page",
"required": false,
"schema": {
"default": 25,
"maximum": 100,
"minimum": 1,
"title": "Per Page",
"type": "integer"
}
},
{
"in": "query",
"name": "sort",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sort"
}
},
{
"in": "query",
"name": "order",
"required": false,
"schema": {
"default": "asc",
"pattern": "^(asc|desc)$",
"title": "Order",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: consumer_create_record_api_v1_public_apps__application_id__models__model_id__records_post

Create a record as an AUTHENTICATED consumer of this application.

Before this route existed there was no such path: the generic model route refuses a ConsumerContext (“Consumer JWTs do not grant generic record creation”), so a page-builder form could only work if its model was auth_required: false – open to anyone who could reach the page. That is why 16 kanban models carry the opt-out in production.

Anonymous intake deliberately stays on the model route, where auth_required governs it. One gate, in one place.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "mf_access",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mf Access"
}
}
]

Responses:

{
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/apps/{application_id}/models/{model_id}/records/{record_id}

Section titled “/api/v1/public/apps/{application_id}/models/{model_id}/records/{record_id}”

Operation id: get_public_record_api_v1_public_apps__application_id__models__model_id__records__record_id__get

Get Public Record

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/apps/{application_id}/models/{model_id}/stats

Section titled “/api/v1/public/apps/{application_id}/models/{model_id}/stats”

Operation id: get_public_model_stats_api_v1_public_apps__application_id__models__model_id__stats_get

Get Public Model Stats

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "model_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Model Id",
"type": "string"
}
},
{
"in": "query",
"name": "aggregation",
"required": false,
"schema": {
"default": "count",
"title": "Aggregation",
"type": "string"
}
},
{
"in": "query",
"name": "field_name",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Field Name"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatsResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/apps/{application_id}/records/{record_id}

Section titled “/api/v1/public/apps/{application_id}/records/{record_id}”

Operation id: consumer_get_record_api_v1_public_apps__application_id__records__record_id__get

Load an edit binding through the same published/ownership read grant as references.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "mf_access",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mf Access"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: consumer_update_record_api_v1_public_apps__application_id__records__record_id__patch

Update a record as an AUTHENTICATED consumer of this application.

This is the BROAD grant: any published field on the record. public_record_action remains the narrow one – declared action keys, declared fields, declared preconditions – and stays the right tool when a consumer should be able to change some things and not others. They are not redundant.

Without this route an edit form without a public_action returns 403 to a logged-in consumer, which pushes builders back to auth_required: false.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "mf_access",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mf Access"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

Operation id: consumer_delete_record_api_v1_public_apps__application_id__records__record_id__delete

Delete a record as an AUTHENTICATED consumer of this application.

The admin route rejects a ConsumerContext outright, which is why deleting from a public app’s own UI returned 403 while the same delete over the admin API returned 204.

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "mf_access",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mf Access"
}
}
]

Responses:

{
"204": {
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}

/api/v1/public/apps/{application_id}/records/{record_id}/actions/{action_key}

Section titled “/api/v1/public/apps/{application_id}/records/{record_id}/actions/{action_key}”

Operation id: public_record_action_api_v1_public_apps__application_id__records__record_id__actions__action_key__post

Public Record Action

Parameters:

[
{
"in": "path",
"name": "application_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Application Id",
"type": "string"
}
},
{
"in": "path",
"name": "record_id",
"required": true,
"schema": {
"format": "uuid",
"title": "Record Id",
"type": "string"
}
},
{
"in": "path",
"name": "action_key",
"required": true,
"schema": {
"title": "Action Key",
"type": "string"
}
},
{
"in": "header",
"name": "authorization",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Authorization"
}
},
{
"in": "cookie",
"name": "mf_access",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mf Access"
}
}
]

Responses:

{
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
}