{"openapi":"3.0.1","info":{"title":"AI Template","description":"API for managing AI templates and their settings\n <b><h1>Deprecated endpoints:</h1></b><table border=\"1px;\"><tr><th style=\"text-align: center; vertical-align: middle;\"><b><h3>Uri</b></h3></th><th><b>Method</b></th><th><b><h3>Since</h3></b></th><th><b><h3>End of life</h3></b></th></tr></table>","license":{"name":"Bluestone PIM"},"version":"1-apps"},"servers":[{"url":"api.test.bluestonepim.com/ai-template"}],"tags":[{"name":"AI Template","description":"Operations for managing AI templates"}],"paths":{"/templates":{"post":{"tags":["AI Template"],"summary":"Create new template","operationId":"createTemplate","security":[{"oauth2":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTemplateRequest"}}}},"responses":{"201":{"description":"Template created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Template name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/templates/list":{"post":{"tags":["AI Template"],"summary":"List templates","operationId":"listTemplates","security":[{"oauth2":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTemplatesRequest"}}}},"responses":{"200":{"description":"List of templates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTemplatesResponse"}}}}}}},"/templates/{templateId}":{"get":{"tags":["AI Template"],"summary":"Get template by ID","operationId":"getTemplate","security":[{"oauth2":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Template details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Template not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"tags":["AI Template"],"summary":"Update template","operationId":"updateTemplate","security":[{"oauth2":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTemplateRequest"}}}},"responses":{"204":{"description":"Template updated successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Template not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Template name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["AI Template"],"summary":"Patch template name","operationId":"patchTemplate","security":[{"oauth2":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchTemplateRequest"}}}},"responses":{"204":{"description":"Template name updated successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Template not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Template name already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["AI Template"],"summary":"Delete template","operationId":"deleteTemplate","security":[{"oauth2":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Template deleted successfully"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Template not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/templates/{templateId}/duplicate":{"post":{"tags":["AI Template"],"summary":"Duplicate existing template","operationId":"duplicateTemplate","security":[{"oauth2":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Template duplicated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/templates/{templateId}/validate":{"post":{"tags":["AI Template"],"summary":"Validate template","operationId":"validateTemplate","security":[{"oauth2":[]}],"parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Template is valid","content":{"application/json":{"schema":{"type":"object","properties":{"isBroken":{"type":"boolean"}}}}}},"400":{"description":"Template validation failed","content":{"application/json":{"schema":{"type":"object","properties":{"isBroken":{"type":"boolean"},"brokenDetails":{"type":"string"}}}}}},"404":{"description":"Template not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Template":{"type":"object","properties":{"templateId":{"type":"string"},"templateName":{"type":"string"},"aiFeature":{"type":"string","enum":["ai-enrich","ai-linguist","ai-analyst"]},"aiFeatureName":{"type":"string"},"aiAction":{"type":"string","enum":["ai-enrich","translate","improve-text","spell-checker","ai-analyst"]},"aiActionName":{"type":"string"},"modelId":{"type":"string"},"modelName":{"type":"string"},"provider":{"type":"string"},"settings":{"$ref":"#/components/schemas/Settings"},"createdAt":{"type":"integer"},"modifiedAt":{"type":"integer"},"createdByName":{"type":"string"},"modifiedByName":{"type":"string"},"createdById":{"type":"string"},"modifiedById":{"type":"string"},"isBroken":{"type":"boolean"}}},"TemplateList":{"type":"object","properties":{"templateId":{"type":"string"},"templateName":{"type":"string"},"aiFeature":{"type":"string","enum":["ai-enrich","ai-linguist","ai-analyst"]},"aiFeatureName":{"type":"string"},"aiAction":{"type":"string","enum":["ai-enrich","translate","improve-text","spell-checker","ai-analyst"]},"aiActionName":{"type":"string"},"modelId":{"type":"string"},"modelName":{"type":"string"},"provider":{"type":"string"},"createdAt":{"type":"integer"},"modifiedAt":{"type":"integer"},"createdByName":{"type":"string"},"modifiedByName":{"type":"string"},"createdById":{"type":"string"},"modifiedById":{"type":"string"},"isBroken":{"type":"boolean"}}},"CreateTemplateRequest":{"type":"object","properties":{"templateName":{"type":"string"},"aiFeature":{"type":"string","enum":["ai-enrich","ai-linguist","ai-analyst"]},"aiFeatureName":{"type":"string"},"aiAction":{"type":"string","enum":["ai-enrich","translate","improve-text","spell-checker","ai-analyst"]},"aiActionName":{"type":"string"},"modelId":{"type":"string"},"modelName":{"type":"string"},"provider":{"type":"string"},"settings":{"$ref":"#/components/schemas/Settings"}}},"UpdateTemplateRequest":{"type":"object","properties":{"templateName":{"type":"string"},"aiFeature":{"type":"string","enum":["ai-enrich","ai-linguist","ai-analyst"]},"aiFeatureName":{"type":"string"},"aiAction":{"type":"string","enum":["ai-enrich","translate","improve-text","spell-checker","ai-analyst"]},"aiActionName":{"type":"string"},"modelId":{"type":"string"},"modelName":{"type":"string"},"provider":{"type":"string"},"settings":{"$ref":"#/components/schemas/Settings"}}},"PatchTemplateRequest":{"type":"object","required":["templateName"],"properties":{"templateName":{"type":"string","minLength":1}}},"ListTemplatesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TemplateList"}},"total":{"type":"integer"}}},"ListTemplatesRequest":{"type":"object","properties":{"page":{"type":"integer","default":0},"pageSize":{"type":"integer","default":20},"filters":{"type":"object","properties":{"aiFeature":{"type":"string","minLength":3},"aiAction":{"type":"string","minLength":3},"modelId":{"type":"string","minLength":3},"isBroken":{"type":"boolean"}}},"search":{"type":"object","properties":{"fields":{"type":"string","enum":["templateName"]},"query":{"type":"string","minLength":2}}},"sort":{"type":"object","properties":{"field":{"type":"string","enum":["templateName","createdAt","modifiedAt","aiActionName","aiFeatureName","createdByName","modifiedByName","modelName"]},"direction":{"type":"string","enum":["asc","desc"],"default":"asc"}}}}},"Settings":{"oneOf":[{"$ref":"#/components/schemas/AiSettingEnrich"},{"$ref":"#/components/schemas/AiSettingLinguistTranslate"},{"$ref":"#/components/schemas/AiSettingLinguistImproveText"},{"$ref":"#/components/schemas/AiSettingLinguistSpellchecker"},{"$ref":"#/components/schemas/AiSettingAnalyst"}]},"AiSettingEnrich":{"type":"object","properties":{"context":{"type":"string"},"contextFallback":{"type":"boolean"},"inputColumnSetupId":{"type":"string"},"outputColumnSetupId":{"type":"string"},"instructions":{"type":"array","items":{"$ref":"#/components/schemas/Instruction"}},"inputAttributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"outputAttributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}},"usingImage":{"type":"boolean"},"assetLabelId":{"type":"string"}}},"AiSettingLinguistTranslate":{"type":"object","properties":{"context":{"type":"string"},"contextFallback":{"type":"boolean"},"outputContext":{"type":"string"},"columnSetupId":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"instructionText":{"type":"string"}}},"AiSettingLinguistImproveText":{"type":"object","properties":{"context":{"type":"string"},"contextFallback":{"type":"boolean"},"columnSetupId":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"instructionText":{"type":"string"}}},"AiSettingLinguistSpellchecker":{"type":"object","properties":{"context":{"type":"string"},"contextFallback":{"type":"boolean"},"columnSetupId":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"instructionText":{"type":"string"}}},"AiSettingAnalyst":{"type":"object","properties":{"context":{"type":"string"},"contextFallback":{"type":"boolean"},"columnSetupId":{"type":"string"},"saveViewId":{"type":"string"},"queryBuilder":{"type":"object"},"trainAttributes":{"type":"array","items":{"$ref":"#/components/schemas/Attribute"}}}},"Instruction":{"oneOf":[{"type":"object","properties":{"input":{"type":"string"},"id":{"type":"string"}},"required":["input","id"],"additionalProperties":false},{"type":"object","properties":{"input":{"type":"string"},"name":{"type":"string"}},"required":["input","name"],"additionalProperties":false}]},"Attribute":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}]},"Column":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"Error":{"type":"object","properties":{"message":{"type":"string"}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://idp.test.bluestonepim.com/op/token","scopes":{"openid profile systemRoles permissions organization email name nickname":"All needed scopes."}}}}}}}