@deepraxis/sdk 0.1.1-dev.d73d5e4 → 0.1.1-dev.d8d3f52

package/dist/generated/sdk.gen.js

@@ -6796,7 +6796,7 @@ export const cutCreateExport = (options) => (options.client ?? client).post({
 /**
  * Create draft range render
  *
- * Render one interval of the timeline so you can hear or look at how that passage comes out, without publishing anything to a media library. Choose kind audio for the mixed soundtrack as an .m4a file, or kind video for a draft-quality .mp4 with picture and sound. from and to are seconds on the project clock and must satisfy 0 <= from < to, to <= the timeline duration, and to - from <= 120; a longer passage is requested in several 分段请求 ranges and joined by the caller. The result is a temporary file (purpose user_data) that expires 24 hours after it is stored and is never imported into a library, so it is not a deliverable and carries no cut-export tag. HTTP 202 only accepts the job; poll praxis.cut.renders.retrieve using the returned id until status is done or failed, then read url while it lasts. A draft also bills like a draft export, by rendered seconds. Each project runs at most 2 draft renders at a time, a budget separate from its exports; a third answers HTTP 429 CUT_BUSY and the same call succeeds once one finishes.
+ * Render one interval of the timeline so you can hear or look at how that passage comes out, without publishing anything to a media library. Choose kind audio for the mixed soundtrack as an .m4a file, or kind video for a draft-quality .mp4 with picture and sound. from and to are seconds on the project clock and must satisfy 0 <= from < to, to <= the timeline duration (an end up to 0.05 s past it, a rounded duration, is read as the end), and to - from <= 120; a longer passage is requested in several 分段请求 ranges and joined by the caller. The result is a temporary file (purpose user_data) that expires 24 hours after it is stored and is never imported into a library, so it is not a deliverable and carries no cut-export tag. HTTP 202 only accepts the job; poll praxis.cut.renders.retrieve using the returned id until status is done or failed, then read url while it lasts. A draft also bills like a draft export, by rendered seconds. Each project runs at most 2 draft renders at a time, a budget separate from its exports; a third answers HTTP 429 CUT_BUSY and the same call succeeds once one finishes.
  */
 export const cutCreateRender = (options) => (options.client ?? client).post({
     security: [{
@@ -8311,6 +8311,88 @@ export const mediaCreateDeliveryToken = (options) => (options.client ?? client).
         ...options.headers
     }
 });
+/**
+ * Get default library
+ *
+ * Return this organization’s default library. Calling ensures the organization’s default library exists (ADR-093): the first call creates it and later calls return the same library, so this is the method to call before writing when no library id is known. Generated and edited media land here when no library is named. The path segment {lib} accepts the literal default, which resolves to this library before the credential check — so an agent that has never listed libraries can still write to the right place. Returns the same Library object as libraries.retrieve; a credential bound to one library reaches this only when that binding covers the default library.
+ */
+export const mediaGetDefaultLibrary = (options) => (options?.client ?? client).get({
+    security: [{
+            key: 'media-BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }],
+    url: '/media/v1/libraries/default',
+    ...options
+});
+/**
+ * Set default library
+ *
+ * Point this organization’s default library at an existing library. Calling ensures the organization’s default library exists (ADR-093): the path is resolved before the credential check, so a first call creates the default library when there is none and then repoints it. The path segment {lib} accepts the literal default, which resolves to this library before the credential check. Supply library_id from library creation or listing; the library must be active and belong to the organization. This changes where library-less generation and uploads land across the whole organization, so it affects other callers as well as this one. It does not move or copy any asset — assets already in the previous default library stay there. Returns the library now set as the default. Deleting the default library is refused with LIBRARY_IS_DEFAULT until another library is made the default.
+ */
+export const mediaSetDefaultLibrary = (options) => (options.client ?? client).put({
+    security: [{
+            key: 'media-BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }],
+    url: '/media/v1/libraries/default',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Get asset lineage
+ *
+ * Read the whole edit tree containing one asset, so a caller sees what it was edited from and what was edited from it. Use library_id from creation or listing and asset_id from asset creation or listing; library_id also accepts the literal default, which resolves to the organization’s default library before the credential check. The response names the root the tree descends from, the asset asked about, and every step between them, each with the operation, prompt and creation time that produced it. Deleted assets stay in the tree, marked deleted, so the chain stays connected after cleanup. This is a read: it starts no processing and changes no asset. Example: GET /media/v1/libraries/lib_example/assets/9dfa312ef9bc4b00816339b598b1152c/lineage.
+ */
+export const mediaGetAssetLineage = (options) => (options.client ?? client).get({
+    security: [{
+            key: 'media-BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }],
+    url: '/media/v1/libraries/{library_id}/assets/{asset_id}/lineage',
+    ...options
+});
+/**
+ * Generate image
+ *
+ * Generate one or more images from a text prompt and store them straight into the library. Use library_id from creation or listing; the path segment {library_id} also accepts the literal default, which resolves to the organization’s default library before the credential check, so an agent that has never listed a library can still generate. The request body is the image request itself: prompt is required, and n, size, background, output_format, output, references, seed, model, asset_folder and understanding are optional. Set output to sticker for a cut-out with a transparent background. references attach existing assets with a role — edit_target, style, structure or subject — and a model that cannot honour a role returns REFERENCE_TYPE_MISMATCH. Aspect ratio is not accepted for images; name size instead. Generation is charged through Router and the job records the charge in usage; nothing is charged for a request refused before it starts. The response is 202 with a queued Job whose type is image and whose operation is generate; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until its status is completed or failed, then read the produced assets from the library. Send Idempotency-Key, or idempotency_key in the body, to retry without generating and charging twice. Example: POST /media/v1/libraries/default/images/generations with {"prompt":"A red kite above a calm sea at sunrise","n":1,"output":"sticker"}.
+ */
+export const mediaGenerateImage = (options) => (options.client ?? client).post({
+    security: [{
+            key: 'media-BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }],
+    url: '/media/v1/libraries/{library_id}/images/generations',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Edit asset
+ *
+ * Edit an existing asset and store the result as a new asset. Use library_id from creation or listing and asset_id from asset creation or listing; library_id also accepts the literal default, which resolves to the organization’s default library before the credential check. The source asset is never overwritten: the new asset hangs under it in the edit chain, records it in derived_from, and reads back with assets.lineage, so earlier steps stay reachable. The body is operation plus the optional model, asset_folder, understanding and idempotency_key; operation.type selects the edit and carries that operation’s own fields. This release performs variations, inpaint, erase, replace_object, recolor, remove_background and replace_background on images; every other type in the operation vocabulary — the video and audio edits — is refused with OPERATION_NOT_SUPPORTED. inpaint takes mask, a PNG File identifier beginning with file- whose transparent area marks the region to replace, plus the prompt describing what belongs there. Aspects beyond the source asset’s material type return REFERENCE_TYPE_MISMATCH. Editing is charged through Router and the job records the charge in usage. The response is 202 with a queued Job whose type is image, whose operation is the edit applied, and whose source_asset_id is the asset edited; poll GET /media/v1/libraries/{library_id}/jobs/{job_id} until it is completed or failed, then read the produced asset. Example: POST /media/v1/libraries/lib_example/assets/9dfa312ef9bc4b00816339b598b1152c/edits with {"operation":{"type":"variations","strength":"subtle"}}.
+ */
+export const mediaEditAsset = (options) => (options.client ?? client).post({
+    security: [{
+            key: 'media-BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }],
+    url: '/media/v1/libraries/{library_id}/assets/{asset_id}/edits',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
 /**
  * Summarize understanding failures
  *
@@ -8480,7 +8562,7 @@ export const ontologyListNodes = (options) => (options?.client ?? client).get({
 /**
  * Create node
  *
- * Record one entity in the graph, for a system mirroring a record it owns. type must already be registered and ref, when given, must match that type's ref_prefix. Send an Idempotency-Key header; repeating the same key with the same content returns the first result instead of creating a second node. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.
+ * Record one entity in the graph, for a system mirroring a record it owns. type must already be registered and ref, when given, must match that type's ref_prefix. Send an Idempotency-Key header; repeating the same key with the same content returns the first result instead of creating a second node. This writes structure only; it does not give any agent a memory.
  */
 export const ontologyCreateNode = (options) => (options.client ?? client).post({
     security: [{
@@ -8527,6 +8609,20 @@ export const ontologyUpdateNode = (options) => (options.client ?? client).patch(
         ...options.headers
     }
 });
+/**
+ * Retrieve neighborhood
+ *
+ * Load the subgraph around one node instead of the whole graph — the read to use when a screen or an agent needs the context of one entity. Returns the start node, every node within depth hops of it, the relations whose both ends are in that set, and truncated true when the node limit cut the walk short. direction chooses which way relations are followed; as_of and include_invalid read the graph as those parameters do elsewhere. Visibility is exactly nodes.retrieve's — a node you may reach but not read comes back restricted with its name only, and relations touching it are withheld, so this read never reaches further than a node read does. The node id comes from nodes.list, nodes.create or a changeset; an unknown one answers ONTOLOGY_NODE_NOT_FOUND, the same answer nodes.retrieve gives.
+ */
+export const ontologyNeighborhood = (options) => (options.client ?? client).get({
+    security: [{
+            key: 'ontology-bearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }],
+    url: '/ontology/v1/nodes/{node_id}/neighborhood',
+    ...options
+});
 /**
  * Merge node
  *
@@ -8562,7 +8658,7 @@ export const ontologyListRelations = (options) => (options?.client ?? client).ge
 /**
  * Create relation
  *
- * Record one fact between two existing nodes, for a system mirroring a relationship it owns. type must be registered and must admit these endpoints; fact states the relationship in one sentence. Send an Idempotency-Key header; repeating the same key returns the first result instead of writing a second relation. This writes structure only — to give an agent something to remember, use POST /agent/v1/agents/{agent_id}/consolidations.
+ * Record one fact between two existing nodes, for a system mirroring a relationship it owns. type must be registered and must admit these endpoints; fact states the relationship in one sentence. Send an Idempotency-Key header; repeating the same key returns the first result instead of writing a second relation. This writes structure only; it does not give any agent a memory.
  */
 export const ontologyCreateRelation = (options) => (options.client ?? client).post({
     security: [{
@@ -8630,7 +8726,7 @@ export const ontologyApplyChangeset = (options) => (options.client ?? client).po
 /**
  * Search nodes
  *
- * Resolve text to the nodes it most likely names, when a mirror holds a name and needs the node id it corresponds to. Results are ranked candidates, not an answer, each reporting whether the match came from the node's name, an alias, its description or a relation's fact. Narrow with types, and cap the result count with limit (1–50, default 20). This reads structure; it is not an agent recall — agents recall through POST /agent/v1/agents/{agent_id}/consolidations.
+ * Resolve text to the nodes it most likely names, when a mirror holds a name and needs the node id it corresponds to. Results are ranked candidates, not an answer, each reporting whether the match came from the node's name, an alias, its description or a relation's fact. Narrow with types, and cap the result count with limit (1–50, default 20). This reads structure; it is not an agent's recall, which reads the graph from that agent's own viewpoint inside its sessions.
  */
 export const ontologySearch = (options) => (options.client ?? client).post({
     security: [{
@@ -10635,7 +10731,7 @@ export const studioTemplatesGet = (options) => (options.client ?? client).get({
 /**
  * List the rendition themes of a platform
  *
- * List themes: the layouts a rendition is produced with, for one platform or for all of them. Pass a platform to see only the themes that platform can use. A theme decides the page or card a rendition is built into, so read the chosen theme before creating a rendition rather than after the output looks wrong.
+ * List themes: the layouts a rendition is produced with, for one platform or for all of them. Pass a platform to see only the themes that platform can use. The first page starts with the built-in themes (builtin true, such as warm-card@1 for Xiaohongshu cards and plain-mono@1 for WeChat articles), which every organization can use and nobody can change or delete; your organization's own themes follow. A theme decides the page or card a rendition is built into, so read the chosen theme before creating a rendition rather than after the output looks wrong.
  */
 export const studioThemesList = (options) => (options?.client ?? client).get({
     security: [{
@@ -10730,6 +10826,158 @@ export const studioThemesUpdate = (options) => (options.client ?? client).patch(
         ...options.headers
     }
 });
+/**
+ * Create a rendition of a draft for a platform
+ *
+ * Create a rendition: the form of one draft that a platform receives, such as a Xiaohongshu card set, a DOCX file or a Markdown file. Read the platform first with the platform call and pass its versioned key; pass a theme only to override the platform's default layout. Pass render true to render in the same call and read render_state and issues in the answer; without it the rendition starts as pending and the render call produces it. Rendering a Xiaohongshu card set is billed by Browser Rendering time (meter browser_ms, product studio-render); DOCX and Markdown renditions are not billed. A draft with no body renders as invalid with a draft_empty issue, and an unavailable render service leaves render_state failed with a render_unavailable issue, so repeat the render call later. Send a request_id to make a repeated call return the first rendition instead of creating another. Next, publish the rendition to export it.
+ */
+export const studioRenditionsCreate = (options) => (options.client ?? client).post({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/studio/v1/works/{work}/drafts/{draft}/renditions',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * List the renditions of a work
+ *
+ * List the renditions of one work, each with its platform, render state, stale flag and publish state. Pass draft to see only the renditions of one draft. Use it to find the rendition to publish or to render again, and read stale before exporting: a stale rendition was built from an older draft and cannot be exported until the render call has rebuilt it. The answer is one page; keep following next_page_token while it is present.
+ */
+export const studioRenditionsList = (options) => (options.client ?? client).get({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/studio/v1/works/{work}/renditions',
+    ...options
+});
+/**
+ * Delete a rendition
+ *
+ * Delete a rendition and stop listing it. The draft it was built from is untouched, and a new rendition can be created from it at any time. Files already downloaded from an earlier export are not affected. Use it to clear a failed or abandoned rendition; to refresh one, call the render operation instead.
+ */
+export const studioRenditionsDelete = (options) => (options.client ?? client).delete({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/studio/v1/works/{work}/renditions/{rendition}',
+    ...options
+});
+/**
+ * Read one rendition
+ *
+ * Read one rendition in full: its render state, the validation issues the render found, the parts (one per card page or thread post), the files it produced and its publish state. Call it after create, render or publish to see the outcome, because a render that finished invalid or failed is reported here and not as an HTTP error. stale is true when the draft has changed since source_revision; call the render operation before exporting a stale rendition.
+ */
+export const studioRenditionsGet = (options) => (options.client ?? client).get({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/studio/v1/works/{work}/renditions/{rendition}',
+    ...options
+});
+/**
+ * Change the theme or settings of a rendition
+ *
+ * Change a rendition's theme or settings. Send update_mask naming exactly the fields you change, such as theme or settings; a field left out keeps its value. The produced files are not rebuilt by this call, so call the render operation afterwards to apply the change. A rendition whose export or publish has started is locked and answers RENDITION_PUBLISH_LOCKED; create a new rendition for new content.
+ */
+export const studioRenditionsUpdate = (options) => (options.client ?? client).patch({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/studio/v1/works/{work}/renditions/{rendition}',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});
+/**
+ * Render a rendition again from the current draft
+ *
+ * Render the rendition from the draft as it is now, replacing its parts and files and clearing stale. Call it after the draft changed, after a theme or settings change, or after a failed render. The answer carries render_state: rendered, invalid when the draft has an error-level issue (for example draft_empty on a draft with no body), or failed when the render service was unavailable (issue render_unavailable; repeat later). A render does not fail the HTTP call for those outcomes, so read render_state and issues. Rendering a Xiaohongshu card set is billed by Browser Rendering time (meter browser_ms, product studio-render); DOCX and Markdown are not billed. Rendering the same rendition twice at once answers REVISION_CONFLICT; retry shortly. Next, publish the rendition to export it.
+ */
+export const studioRenditionsRender = (options) => (options.client ?? client).post({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/studio/v1/works/{work}/renditions/{rendition}:render',
+    ...options
+});
+/**
+ * Export a rendition
+ *
+ * Export a rendition for the platforms that deliver a file: markdown@1, docx@1 and xiaohongshu@1 end with publish.state exported, and a card rendition gains one ZIP of its pages in files. Publishing to a platform account such as X or WeChat is not available yet and answers PLATFORM_NOT_AVAILABLE; export instead. The rendition must be rendered, not stale and without error-level issues: RENDITION_NOT_RENDERED means call the render operation first, RENDITION_STALE means the draft changed so render again, RENDITION_INVALID means fix the draft problems listed in issues and render again. Exporting the same rendition twice at once answers REVISION_CONFLICT; retry shortly. Next, call the content operation to download the file.
+ */
+export const studioRenditionsPublish = (options) => (options.client ?? client).post({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/studio/v1/works/{work}/renditions/{rendition}:publish',
+    ...options
+});
+/**
+ * Get a download URL for a rendition file
+ *
+ * Get a signed, short-lived URL to download what a rendition produced. Without part it points to the rendition's own first file: the ZIP of pages for a card rendition, the DOCX for docx@1. With part it points to that part's first file, such as one card PNG; a part that has no file, or a rendition not rendered yet, answers RENDITION_NOT_RENDERED, and an index no part has answers INVALID_PARAMS. Call it after a successful render or export, download the url before expire_time, and call again for a fresh one when it has expired. The URL is a credential: do not store or share it.
+ */
+export const studioRenditionsContentUrl = (options) => (options.client ?? client).get({
+    security: [{
+            key: 'BearerAuth',
+            scheme: 'bearer',
+            type: 'http'
+        }, {
+            key: 'ApiKeyAuth',
+            name: 'X-API-Key',
+            type: 'apiKey'
+        }],
+    url: '/studio/v1/works/{work}/renditions/{rendition}/content',
+    ...options
+});
 /**
  * List vaults
  *