@sogni-ai/sogni-protocol 1.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/README.md +80 -0
  2. package/catalogs/audio-models.json +34 -0
  3. package/catalogs/quality-presets.json +30 -0
  4. package/enums/chat-run-status.json +12 -0
  5. package/enums/chat-run-waiting-reasons.json +10 -0
  6. package/enums/token-types.json +7 -0
  7. package/enums/tool-names.json +85 -0
  8. package/manifests/app-tools.json +297 -0
  9. package/manifests/composition-tools.json +228 -0
  10. package/manifests/generation-tools.json +1263 -0
  11. package/manifests/openai-tools.json +1818 -0
  12. package/package.json +44 -0
  13. package/prompts/tools/add_subtitles.json +12 -0
  14. package/prompts/tools/analyze_image.json +12 -0
  15. package/prompts/tools/analyze_video.json +11 -0
  16. package/prompts/tools/animate_photo.json +13 -0
  17. package/prompts/tools/apply_style.json +11 -0
  18. package/prompts/tools/ask_clarifying_question.json +10 -0
  19. package/prompts/tools/change_angle.json +11 -0
  20. package/prompts/tools/compose_instrumental.json +11 -0
  21. package/prompts/tools/compose_lyrics.json +12 -0
  22. package/prompts/tools/compose_script.json +21 -0
  23. package/prompts/tools/compose_workflow.json +17 -0
  24. package/prompts/tools/compose_workflow_template.json +23 -0
  25. package/prompts/tools/create_asset_manifest.json +9 -0
  26. package/prompts/tools/dance_montage.json +9 -0
  27. package/prompts/tools/edit_image.json +11 -0
  28. package/prompts/tools/enhance_prompt.json +20 -0
  29. package/prompts/tools/extend_video.json +11 -0
  30. package/prompts/tools/extract_metadata.json +9 -0
  31. package/prompts/tools/finalize_response.json +10 -0
  32. package/prompts/tools/generate_image.json +11 -0
  33. package/prompts/tools/generate_music.json +7 -0
  34. package/prompts/tools/generate_video.json +10 -0
  35. package/prompts/tools/inspect_asset.json +10 -0
  36. package/prompts/tools/label_asset.json +13 -0
  37. package/prompts/tools/manage_memory.json +12 -0
  38. package/prompts/tools/map_assets_for_model.json +9 -0
  39. package/prompts/tools/orbit_video.json +13 -0
  40. package/prompts/tools/overlay_video.json +10 -0
  41. package/prompts/tools/refine_result.json +11 -0
  42. package/prompts/tools/replace_video_segment.json +14 -0
  43. package/prompts/tools/resolve_personas.json +9 -0
  44. package/prompts/tools/restore_photo.json +12 -0
  45. package/prompts/tools/set_content_filter.json +9 -0
  46. package/prompts/tools/sound_to_video.json +9 -0
  47. package/prompts/tools/stitch_video.json +9 -0
  48. package/prompts/tools/validate_asset_references.json +10 -0
  49. package/prompts/tools/video_to_video.json +13 -0
  50. package/schemas/errors/error.schema.json +21 -0
  51. package/schemas/errors/repair-control.schema.json +40 -0
  52. package/schemas/events/artifact-reference.schema.json +22 -0
  53. package/schemas/events/progress-event.schema.json +28 -0
  54. package/schemas/events/workflow-event.schema.json +22 -0
  55. package/schemas/prompt-contract.schema.json +42 -0
  56. package/schemas/storyboards/storyboard-planning-contract.schema.json +108 -0
  57. package/schemas/tools/add_subtitles.schema.json +77 -0
  58. package/schemas/tools/animate_photo.schema.json +104 -0
  59. package/schemas/tools/apply_style.schema.json +37 -0
  60. package/schemas/tools/change_angle.schema.json +30 -0
  61. package/schemas/tools/compose_instrumental.schema.json +24 -0
  62. package/schemas/tools/compose_lyrics.schema.json +28 -0
  63. package/schemas/tools/compose_script.schema.json +68 -0
  64. package/schemas/tools/compose_workflow.schema.json +67 -0
  65. package/schemas/tools/compose_workflow_template.schema.json +156 -0
  66. package/schemas/tools/dance_montage.schema.json +47 -0
  67. package/schemas/tools/edit_image.schema.json +74 -0
  68. package/schemas/tools/enhance_prompt.schema.json +76 -0
  69. package/schemas/tools/extend_video.schema.json +42 -0
  70. package/schemas/tools/generate_image.schema.json +104 -0
  71. package/schemas/tools/generate_music.schema.json +62 -0
  72. package/schemas/tools/generate_video.schema.json +97 -0
  73. package/schemas/tools/manage_memory.schema.json +28 -0
  74. package/schemas/tools/orbit_video.schema.json +70 -0
  75. package/schemas/tools/overlay_video.schema.json +126 -0
  76. package/schemas/tools/refine_result.schema.json +43 -0
  77. package/schemas/tools/replace_video_segment.schema.json +60 -0
  78. package/schemas/tools/resolve_personas.schema.json +15 -0
  79. package/schemas/tools/restore_photo.schema.json +47 -0
  80. package/schemas/tools/set_content_filter.schema.json +14 -0
  81. package/schemas/tools/sound_to_video.schema.json +70 -0
  82. package/schemas/tools/stitch_video.schema.json +52 -0
  83. package/schemas/tools/video_to_video.schema.json +77 -0
  84. package/schemas/workflows/durable-workflow-run.schema.json +165 -0
  85. package/schemas/workflows/durable-workflow-step.schema.json +141 -0
  86. package/version.json +4 -0
package/schemas/workflows/durable-workflow-step.schema.json ADDED
@@ -0,0 +1,141 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schemas.sogni.ai/creative-agent/2026-04-27.1/workflows/durable-workflow-step.schema.json",
4
+ "title": "Creative agent durable workflow step metadata",
5
+ "schemaVersion": "2026-04-27.1",
6
+ "type": "object",
7
+ "additionalProperties": false,
8
+ "properties": {
9
+ "id": { "type": "string" },
10
+ "workflowId": { "type": "string" },
11
+ "sequence": { "type": "integer", "minimum": 0 },
12
+ "status": { "type": "string", "enum": ["queued", "running", "completed", "partial_failure", "waiting_for_user", "failed", "cancelled"] },
13
+ "backbone": {
14
+ "type": "object",
15
+ "additionalProperties": false,
16
+ "properties": {
17
+ "schemaVersion": { "type": "string" },
18
+ "modelKnowledgeVersion": { "type": "string" },
19
+ "routingPolicyVersion": { "type": "string" }
20
+ },
21
+ "required": ["schemaVersion", "modelKnowledgeVersion", "routingPolicyVersion"]
22
+ },
23
+ "implementation": {
24
+ "type": "object",
25
+ "additionalProperties": false,
26
+ "properties": {
27
+ "runtime": { "type": "string", "enum": ["sogni-chat", "sogni-api", "sogni-client", "creative-agent", "other"] },
28
+ "version": { "type": "string" }
29
+ },
30
+ "required": ["runtime", "version"]
31
+ },
32
+ "tool": {
33
+ "type": "object",
34
+ "additionalProperties": false,
35
+ "properties": {
36
+ "name": { "type": "string" },
37
+ "schemaVersion": { "type": "string" }
38
+ },
39
+ "required": ["name", "schemaVersion"]
40
+ },
41
+ "input": {
42
+ "type": "object",
43
+ "additionalProperties": false,
44
+ "properties": {
45
+ "arguments": { "type": "object", "additionalProperties": true },
46
+ "normalizedArguments": { "type": "object", "additionalProperties": true }
47
+ },
48
+ "required": ["arguments", "normalizedArguments"]
49
+ },
50
+ "generation": {
51
+ "type": "object",
52
+ "additionalProperties": false,
53
+ "properties": {
54
+ "selectedModel": { "type": "string" },
55
+ "params": { "type": "object", "additionalProperties": true }
56
+ },
57
+ "required": ["selectedModel", "params"]
58
+ },
59
+ "routing": {
60
+ "type": "object",
61
+ "additionalProperties": false,
62
+ "properties": {
63
+ "selectedBy": { "type": "string" },
64
+ "reasons": { "type": "array", "items": { "type": "string" } },
65
+ "alternatives": {
66
+ "type": "array",
67
+ "items": {
68
+ "type": "object",
69
+ "additionalProperties": false,
70
+ "properties": {
71
+ "modelId": { "type": "string" },
72
+ "available": { "type": "boolean" },
73
+ "reason": { "type": "string" }
74
+ },
75
+ "required": ["modelId"]
76
+ }
77
+ }
78
+ },
79
+ "required": ["selectedBy", "reasons", "alternatives"]
80
+ },
81
+ "cost": {
82
+ "type": "object",
83
+ "additionalProperties": false,
84
+ "properties": {
85
+ "estimate": {
86
+ "type": "object",
87
+ "additionalProperties": false,
88
+ "properties": {
89
+ "costClass": { "type": "string" },
90
+ "unit": { "type": "string", "enum": ["image", "second", "operation"] },
91
+ "quantity": { "type": "number", "minimum": 0 }
92
+ },
93
+ "required": ["costClass", "unit", "quantity"]
94
+ },
95
+ "actual": { "type": "object", "additionalProperties": true }
96
+ },
97
+ "required": ["estimate"]
98
+ },
99
+ "artifacts": {
100
+ "type": "array",
101
+ "items": { "type": "object", "additionalProperties": true }
102
+ },
103
+ "idempotencyKey": { "type": "string" },
104
+ "retry": {
105
+ "type": "object",
106
+ "additionalProperties": false,
107
+ "properties": {
108
+ "count": { "type": "integer", "minimum": 0 },
109
+ "classification": { "type": "string", "enum": ["none", "transient", "permanent", "unknown"] }
110
+ },
111
+ "required": ["count", "classification"]
112
+ },
113
+ "timestamps": {
114
+ "type": "object",
115
+ "additionalProperties": false,
116
+ "properties": {
117
+ "createdAt": { "type": "string", "format": "date-time" },
118
+ "updatedAt": { "type": "string", "format": "date-time" },
119
+ "completedAt": { "type": "string", "format": "date-time" }
120
+ },
121
+ "required": ["createdAt", "updatedAt"]
122
+ }
123
+ },
124
+ "required": [
125
+ "id",
126
+ "workflowId",
127
+ "sequence",
128
+ "status",
129
+ "backbone",
130
+ "implementation",
131
+ "tool",
132
+ "input",
133
+ "generation",
134
+ "routing",
135
+ "cost",
136
+ "artifacts",
137
+ "idempotencyKey",
138
+ "retry",
139
+ "timestamps"
140
+ ]
141
+ }
package/version.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "protocolVersion": "1.1.0",
3
+ "description": "Sogni protocol artifact version. SDKs may refuse to operate against a protocolVersion they were not built for. Bump the major when removing or renaming any schema / enum / manifest field; bump the minor when adding new optional fields or new tools; bump the patch for description / prose changes only."
4
+ }