{ { "openapi": "3.1.0", "info": { "title": "Get City Name Standard API", "description": "This API uses specialized algorithms and AI models to standardize city names, providing a consistent format for city data.\nTo use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\nFor more information about this API, visit the [Get City Name Standard API Documentation](https://www.interzoid.com/apis/standardize-city-data).\n", "version": "1.0.0", "contact": { "name": "Interzoid Support", "url": "https://www.interzoid.com", "email": "support@interzoid.com" } }, "externalDocs": { "description": "API home page and documentation", "url": "https://www.interzoid.com/apis/standardize-city-data" }, "servers": [ { "url": "https://api.interzoid.com", "description": "Production server" } ], "tags": [ { "name": "City Name Standardization", "description": "Standardizes city names for consistency across datasets." } ], "paths": { "/getcitystandard": { "get": { "operationId": "getCityStandard", "tags": [ "City Name Standardization" ], "summary": "Standardize a City Name", "description": "Standardizes a given city name using AI and algorithms. Include your API key (license) in the request. Register for an API key at https://www.interzoid.com/register-api-account.\n", "parameters": [ { "name": "license", "in": "query", "required": true, "description": "Your API license key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\n", "schema": { "type": "string" }, "examples": { "license": { "summary": "API Key Example", "value": "dh8dj2f*****" } } }, { "name": "city", "in": "query", "required": true, "description": "The city name to be standardized.", "schema": { "type": "string" }, "examples": { "cityName": { "summary": "City Name Example", "value": "L.A." } } }, { "name": "algorithm", "in": "query", "required": true, "description": "The algorithm and AI model used to standardize the city name.", "schema": { "type": "string" }, "examples": { "algorithm": { "summary": "Algorithm Example", "value": "ai-medium" } } } ], "responses": { "200": { "description": "Successful response containing the standardized city name.", "content": { "application/json": { "schema": { "type": "object", "properties": { "CityStandard": { "type": "string", "description": "The standardized city name." }, "Credits": { "type": "integer", "description": "Remaining credits for your API license." }, "Code": { "type": "string", "description": "Response code, \"Success\" if the call is successful." } } }, "examples": { "success": { "value": { "CityStandard": "Los Angeles", "Credits": 99889, "Code": "Success" } } } } } }, "400": { "description": "Bad request (e.g., missing or invalid parameters).", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Invalid license key or city name missing." } } } } }, "402": { "description": "API key not found.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "API key not found." } } } } }, "403": { "description": "Insufficient API credits remaining.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Insufficient API credits remaining." } } } } }, "405": { "description": "Method not allowed.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Method not allowed." } } } } }, "429": { "description": "Rate limits reached.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Rate limits reached." } } } } }, "500": { "description": "Internal server error.", "content": { "text/plain": { "schema": { "type": "string" }, "examples": { "error": { "value": "Internal server error." } } } } } } } } }, "components": { "securitySchemes": { "apiKeyAuth": { "type": "apiKey", "name": "license", "in": "query" } }, "schemas": {} }, "security": [ { "apiKeyAuth": [] } ] }