{"docs":{"name":"Classydoc AI","info":"\n\u003cp\u003eRESTful API for Classydoc AI, version 1.0.\u003c/p\u003e\n","copyright":null,"doc_url":"/docs/1.0","api_url":"https://app.classydoc.ai/api","resources":{"classify":{"doc_url":"/docs/1.0/classify","id":"classify","api_url":"https://app.classydoc.ai/api","name":"Classify","short_description":"Content Classification API","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/classify/create","name":"create","apis":[{"api_url":"https://app.classydoc.ai/api/v1/content/classify","http_method":"POST","short_description":"Classify content by schema","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized - Account API key missing or invalid","metadata":null},{"code":403,"description":"Forbidden - Request limit exceeded for this month","metadata":null},{"code":403,"description":"Forbidden - Must subscribe to a plan to access this feature","metadata":null},{"code":403,"description":"Forbidden - Upgrade your plan to use this schema","metadata":null},{"code":404,"description":"Not Found - Classification schema not found","metadata":null},{"code":422,"description":"Unprocessable Entity - Content is required","metadata":null},{"code":422,"description":"Unprocessable Entity - Content size exceeds the plan's character limit","metadata":null},{"code":422,"description":"Unprocessable Entity - Error saving classification result to the database","metadata":null},{"code":500,"description":"Internal Server Error - An unexpected error occurred","metadata":null}],"params":[{"name":"content","full_name":"content","description":"\n\u003cp\u003eContent to be classified\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"metadata","full_name":"metadata","description":"\n\u003cp\u003eAdditional metadata (optional)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"classificationSchemaId","full_name":"classificationSchemaId","description":"\n\u003cp\u003eID of the classification schema\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":201,"description":"Content successfully classified and saved to the database","is_array":false,"returns_object":[{"name":"content","full_name":"content","description":"\n\u003cp\u003eThe content that was classified\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false},{"name":"metadata","full_name":"metadata","description":"\n\u003cp\u003eAdditional metadata for the content\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false},{"name":"classificationSchemaId","full_name":"classificationSchemaId","description":"\n\u003cp\u003eID of the classification schema used\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"classificationResult","full_name":"classificationResult","description":"\n\u003cp\u003eClassification result\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]}],"examples":["# Sample server response\n{\n  \"content\": \"Congratulations! You've won a $1,000 gift card. Click here to claim your prize!\",\n  \"metadata\": {},\n  \"classificationSchemaId\": 1,\n  \"classificationResult\": \"spam\"\n}\n"],"metadata":null,"see":[],"headers":[{"name":"ApiKey","description":"Contains your API key","options":{"required":true}}],"show":true}],"headers":[],"deprecated":false}}}}