{"openapi":"3.1.0","info":{"title":"Typetone Public API","termsOfService":"https://www.typetone.ai/terms-of-service","contact":{"name":"Typetone","email":"info@typetone.ai"},"version":"1.0.0"},"servers":[{"url":"/public"}],"paths":{"/v1/document/{id}":{"get":{"tags":["document"],"summary":"Get document by ID","operationId":"document-get_document_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAPIDocumentSchema"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/document":{"post":{"tags":["document"],"summary":"Generate a document","operationId":"document-generate_document","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentGenerateInput"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentGenerateResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/healthz":{"get":{"tags":["health"],"summary":"Health check","operationId":"health-healthz","responses":{"200":{"description":"Health check response","content":{"application/health+json":{"schema":{"properties":{"status":{"type":"string","enum":["pass","fail"],"title":"Status"}},"type":"object","required":["status"],"title":"HealthCheckResponse"}}}}},"security":[]}},"/v1/infobase":{"get":{"tags":["infobase"],"summary":"Get infobases","operationId":"infobase-get_infobase","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PublicAPIInfobaseSchema"},"type":"array","title":"Response Infobase-Get Infobase"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"APIKeyHeader":[]}]}},"/v1/infobase/{id}":{"get":{"tags":["infobase"],"summary":"Get infobase by ID","operationId":"infobase-get_infobase_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAPIInfobaseSchema"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/template":{"get":{"tags":["template"],"summary":"Get templates","operationId":"template-get_template","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PublicAPITemplateSchema"},"type":"array","title":"Response Template-Get Template"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"APIKeyHeader":[]}]}},"/v1/template/{id}":{"get":{"tags":["template"],"summary":"Get template by ID","operationId":"template-get_template_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAPITemplateSchema"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/toneofvoice":{"get":{"tags":["toneofvoice"],"summary":"Get tones of voice","operationId":"toneofvoice-get_toneofvoice","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PublicAPIToneOfVoiceSchema"},"type":"array","title":"Response Toneofvoice-Get Toneofvoice"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"APIKeyHeader":[]}]}},"/v1/toneofvoice/{id}":{"get":{"tags":["toneofvoice"],"summary":"Get tone of voice by ID","operationId":"toneofvoice-get_toneofvoice_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicAPIToneOfVoiceSchema"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DocumentGenerateInput":{"properties":{"templateId":{"type":"string","title":"Templateid"},"language_key":{"$ref":"#/components/schemas/LanguageKey"},"input":{"type":"string","contentMediaType":"application/json","contentSchema":{},"title":"Input","description":"The input passed to the template parameters. Which fields should be added depends per template, and can be queried from the `/template` endpoint","examples":["{\"text\":\"The benefits of AI in software development\",\"tone\":\"Professional yet approachable\"}"]},"toneOfVoiceMetaId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Toneofvoicemetaid"}},"type":"object","required":["templateId","language_key","input"],"title":"DocumentGenerateInput"},"DocumentGenerateResponse":{"properties":{"message":{"type":"string","title":"Message"},"documentId":{"type":"string","title":"Documentid"}},"type":"object","required":["message","documentId"],"title":"DocumentGenerateResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LanguageKey":{"type":"string","enum":["NL","EN","ES","IT","GR","SE","PT","FR","FI","PL","DE","TR","DK","RU","NO"],"title":"LanguageKey"},"PublicAPIDocumentSchema":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"shared":{"type":"boolean","title":"Shared"},"document":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Document"},"rawDocument":{"type":"string","title":"Rawdocument"},"generatedOutput":{"type":"string","title":"Generatedoutput"},"bulkInputId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bulkinputid"},"languageKey":{"anyOf":[{"$ref":"#/components/schemas/LanguageKey"},{"type":"null"}]},"templateId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Templateid"},"toneOfVoiceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Toneofvoiceid"}},"type":"object","required":["id","title","shared","rawDocument","generatedOutput"],"title":"PublicAPIDocumentSchema"},"PublicAPIInfobaseSchema":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["id","name"],"title":"PublicAPIInfobaseSchema"},"PublicAPITemplateSchema":{"properties":{"id":{"type":"string","title":"Id"},"key":{"type":"string","title":"Key"},"commands":{"items":{"$ref":"#/components/schemas/_PublicAPITemplateCommandsRelationshipSchema"},"type":"array","title":"Commands"},"templateMetas":{"items":{"$ref":"#/components/schemas/_PublicAPITemplateTemplateMetaRelationshipSchema"},"type":"array","title":"Templatemetas"}},"type":"object","required":["id","key","commands","templateMetas"],"title":"PublicAPITemplateSchema"},"PublicAPIToneOfVoiceSchema":{"properties":{"id":{"type":"string","title":"Id"},"key":{"type":"string","title":"Key"},"toneOfVoiceMetas":{"items":{"$ref":"#/components/schemas/_PublicAPIToneOfVoiceToneOfVoiceMetaRelationshipSchema"},"type":"array","title":"Toneofvoicemetas"}},"type":"object","required":["id","key","toneOfVoiceMetas"],"title":"PublicAPIToneOfVoiceSchema"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"_PublicAPITemplateCommandsRelationshipSchema":{"properties":{"id":{"type":"string","title":"Id"},"languageKey":{"$ref":"#/components/schemas/LanguageKey"}},"type":"object","required":["id","languageKey"],"title":"_PublicAPITemplateCommandsRelationshipSchema"},"_PublicAPITemplateTemplateMetaRelationshipSchema":{"properties":{"id":{"type":"string","title":"Id"},"languageKey":{"$ref":"#/components/schemas/LanguageKey"},"form":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Form"}},"type":"object","required":["id","languageKey","form"],"title":"_PublicAPITemplateTemplateMetaRelationshipSchema"},"_PublicAPIToneOfVoiceToneOfVoiceMetaRelationshipSchema":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"languageKey":{"$ref":"#/components/schemas/LanguageKey"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"toneOfVoiceId":{"type":"string","title":"Toneofvoiceid"}},"type":"object","required":["id","name","languageKey","toneOfVoiceId"],"title":"_PublicAPIToneOfVoiceToneOfVoiceMetaRelationshipSchema"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}}}}