trans2

Paused

App Files Files Community

trans2 / tests /integration-tests /client /docs /DefaultApi.md

Mayo

test: Rust integration tests + Vitest UI tests

5242e6a unverified about 2 months ago

preview code

raw

history blame contribute delete

23.7 kB

\DefaultApi

All URIs are relative to http://localhost

Method	HTTP request	Description
add_image_layer	POST /pages/{id}/image-layers
apply_command	POST /history/apply
cancel_operation	DELETE /operations/{id}
clear_provider_secret	DELETE /config/providers/{id}/secret	Clear a provider's keyring secret. The provider entry itself is kept.
create_pages	POST /pages
create_project	POST /projects
delete_current_llm	DELETE /llm/current
delete_current_project	DELETE /projects/current
events	GET /events
export_current_project	POST /projects/current/export
fetch_google_font	POST /google-fonts/{family}/fetch
get_blob	GET /blobs/{hash}
get_catalog	GET /llm/catalog
get_config	GET /config
get_current_llm	GET /llm/current
get_engine_catalog	GET /engines
get_google_font_file	GET /google-fonts/{family}/{file}
get_google_fonts_catalog	GET /google-fonts
get_meta	GET /meta
get_page_thumbnail	GET /pages/{id}/thumbnail
get_scene_bin	GET /scene.bin
get_scene_json	GET /scene.json
import_project	POST /projects/import
list_fonts	GET /fonts
list_projects	GET /projects
patch_config	PATCH /config
put_current_llm	PUT /llm/current
put_current_project	PUT /projects/current
put_mask	PUT /pages/{id}/masks/{role}	Upsert the `Mask { role }` node on a page with the raw image bytes in the body. Emits `Op::UpdateNode` if a mask of that role exists, else `Op::AddNode`. Used by the repair-brush / segment-edit flow; the follow-up localized inpaint is a separate `POST /pipelines` call.
redo	POST /history/redo
set_provider_secret	PUT /config/providers/{id}/secret	Save (or overwrite) the keyring secret for a provider. Creates the provider entry in `config.providers` if it didn't exist. `PUT` because setting the secret is idempotent for the same body.
start_download	POST /downloads
start_pipeline	POST /pipelines
undo	POST /history/undo

add_image_layer

models::AddImageLayerResponse add_image_layer(id)

Parameters

Name	Type	Description	Required	Notes
id	uuid::Uuid	Page id	[required]

Return type

models::AddImageLayerResponse

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apply_command

models::HistoryResult apply_command(op)

Parameters

Name	Type	Description	Required	Notes
op	Op		[required]

Return type

models::HistoryResult

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancel_operation

cancel_operation(id)

Parameters

Name	Type	Description	Required	Notes
id	String	Operation id	[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

clear_provider_secret

clear_provider_secret(id) Clear a provider's keyring secret. The provider entry itself is kept.

Parameters

Name	Type	Description	Required	Notes
id	String	Provider id	[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_pages

models::CreatePagesResponse create_pages()

Parameters

This endpoint does not need any parameter.

Return type

models::CreatePagesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_project

models::ProjectSummary create_project(create_project_request)

Parameters

Name	Type	Description	Required	Notes
create_project_request	CreateProjectRequest		[required]

Return type

models::ProjectSummary

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_current_llm

delete_current_llm()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_current_project

delete_current_project()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

events

models::AppEvent events()

Parameters

This endpoint does not need any parameter.

Return type

models::AppEvent

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

export_current_project

export_current_project(export_project_request)

Parameters

Name	Type	Description	Required	Notes
export_project_request	ExportProjectRequest		[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_google_font

fetch_google_font(family)

Parameters

Name	Type	Description	Required	Notes
family	String	Google Fonts family name	[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_blob

get_blob(hash)

Parameters

Name	Type	Description	Required	Notes
hash	String	Blake3 hash of the blob	[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_catalog

models::LlmCatalog get_catalog()

Parameters

This endpoint does not need any parameter.

Return type

models::LlmCatalog

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_config

models::AppConfig get_config()

Parameters

This endpoint does not need any parameter.

Return type

models::AppConfig

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_current_llm

models::LlmState get_current_llm()

Parameters

This endpoint does not need any parameter.

Return type

models::LlmState

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_engine_catalog

models::EngineCatalog get_engine_catalog()

Parameters

This endpoint does not need any parameter.

Return type

models::EngineCatalog

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_google_font_file

get_google_font_file(family, file)

Parameters

Name	Type	Description	Required	Notes
family	String	Google Fonts family name	[required]
file	String	Font filename	[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: font/ttf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_google_fonts_catalog

models::GoogleFontCatalog get_google_fonts_catalog()

Parameters

This endpoint does not need any parameter.

Return type

models::GoogleFontCatalog

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_meta

models::MetaInfo get_meta()

Parameters

This endpoint does not need any parameter.

Return type

models::MetaInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_page_thumbnail

get_page_thumbnail(id)

Parameters

Name	Type	Description	Required	Notes
id	uuid::Uuid	Page id	[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: image/webp

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_scene_bin

get_scene_bin()

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_scene_json

models::SceneSnapshot get_scene_json()

Parameters

This endpoint does not need any parameter.

Return type

models::SceneSnapshot

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

import_project

models::ProjectSummary import_project()

Parameters

This endpoint does not need any parameter.

Return type

models::ProjectSummary

Authorization

No authorization required

HTTP request headers

Content-Type: application/zip
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_fonts

Vecmodels::FontFaceInfo list_fonts()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::FontFaceInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_projects

models::ListProjectsResponse list_projects()

Parameters

This endpoint does not need any parameter.

Return type

models::ListProjectsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_config

models::AppConfig patch_config(config_patch)

Parameters

Name	Type	Description	Required	Notes
config_patch	ConfigPatch		[required]

Return type

models::AppConfig

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_current_llm

put_current_llm(llm_load_request)

Parameters

Name	Type	Description	Required	Notes
llm_load_request	LlmLoadRequest		[required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_current_project

models::ProjectSummary put_current_project(open_project_request)

Parameters

Name	Type	Description	Required	Notes
open_project_request	OpenProjectRequest		[required]

Return type

models::ProjectSummary

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_mask

models::PutMaskResponse put_mask(id, role) Upsert the Mask { role } node on a page with the raw image bytes in the body. Emits Op::UpdateNode if a mask of that role exists, else Op::AddNode. Used by the repair-brush / segment-edit flow; the follow-up localized inpaint is a separate POST /pipelines call.

Parameters

Name	Type	Description	Required	Notes
id	uuid::Uuid	Page id	[required]
role	MaskRole	Mask role (segment	brushInpaint)	[required]

Return type

models::PutMaskResponse

Authorization

No authorization required

HTTP request headers

Content-Type: image/png
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

redo

models::HistoryResult redo()

Parameters

This endpoint does not need any parameter.

Return type

models::HistoryResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_provider_secret

set_provider_secret(id, provider_secret_request) Save (or overwrite) the keyring secret for a provider. Creates the provider entry in config.providers if it didn't exist. PUT because setting the secret is idempotent for the same body.