Skip to content

api.md

Latest commit

 

History

History
59 lines (41 loc) · 2.05 KB

api.md

File metadata and controls

59 lines (41 loc) · 2.05 KB
Raw

API reference

Resource methods on the nureta.Nureta client. The generated *_task names (e.g. create_video_task) remain available on each resource too.

Videos — client.videos

Types: CreateVideoTaskParams, VideoSegmentInput, EditPlanParams, EditPlanStructuredParams, Task, Scene, TaskStep

Method HTTP Returns
create(params) POST /api/v3/contents/generations/tasks TaskCreated
retrieve(task_id) GET /api/v3/contents/generations/tasks/{id} Task
edit_plan(task_id, params) PUT .../{id}/plan Task
edit_plan_structured(task_id, params) PUT .../{id}/plan/structured Task (202)
render(task_id) POST .../{id}/render Task
cancel(task_id) POST .../{id}/cancel Task

Images — client.images

Types: CreateImageTaskParams, ImageModel, Task

Method HTTP Returns
create(params) POST /api/v3/images/generations/tasks TaskCreated
retrieve(task_id) GET /api/v3/images/generations/tasks/{id} Task
list_models() GET /api/v3/images/models ImageModelsResponse

Scripts — client.scripts

Types: CreateScriptTaskParams, Script, ScriptScene, ScriptModel

Method HTTP Returns
create(params) POST /api/v3/contents/scripts TaskCreated
retrieve(task_id) GET /api/v3/contents/scripts/{id} Task
list_models() GET /api/v3/scripts/models ScriptModelsResponse

Uploads — client.uploads

Types: CreateUploadParams, Upload

Method HTTP Returns
create(params) POST /api/v3/contents/uploads Upload

Models — client.models

Types: VideoModel

Method HTTP Returns
list() GET /api/v3/models VideoModelsResponse

Shared content types

ContentPart (TextContentPart | ImageContentPart | AudioContentPart) — the content array shared by video and image tasks. Errors raise nureta.exceptions.ApiException; the body carries an Error with a code.