--- updatedAt: 2026-06-05T18:59:12.000Z agentTools: projectIndex: https://developer.eagleeyenetworks.com/llms.txt --- # /languages This endpoint allows you to retrieve a list of languages supported by the service. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available languages, not the number of languages resulting from the query string. # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "SYSTEM", "version": "3.0.0" }, "servers": [ { "url": "https://{BaseUrl}/api/v3.0", "description": "Eagle Eye Networks API Server", "variables": { "BaseUrl": { "default": "api.cxxx.eagleeyenetworks.com", "description": "HTTPS Base url to use for all API calls, retrieved from https://api.eagleeyenetworks.com/api/v3.0/clientSettings" } } } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Applications", "description": "Applications that can get access to an account and interact with it." } ], "paths": { "/languages": { "get": { "operationId": "listLanguages", "description": "This endpoint allows you to retrieve a list of languages supported by the service. \nIt is important to note that after using the pageSize parameter, the \"totalSize\" in the response represents the total number of available languages, not the number of languages resulting from the query string.\n", "tags": [ "Applications" ], "parameters": [ { "$ref": "#/components/parameters/pageToken" }, { "$ref": "#/components/parameters/pageSize" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLanguageResponse" } } } }, "400": { "$ref": "#/components/responses/validationError" }, "401": { "$ref": "#/components/responses/unauthorized" }, "500": { "$ref": "#/components/responses/internalServerError" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "PaginatedResponseWithSize": { "description": "Used to wrap results for a paginated response, containing information on how to retrieve further pages and the total number of results. \n", "allOf": [ { "$ref": "#/components/schemas/PaginatedResponseNoTotalSize" }, { "properties": { "totalSize": { "type": "integer", "readOnly": true, "description": "Size of the total result set.\n" } }, "required": [ "totalSize" ] } ] }, "PaginatedResponseNoTotalSize": { "type": "object", "description": "Used to wrap results for a paginated response, containing information on how to retrieve further pages.\n", "properties": { "nextPageToken": { "type": "string", "readOnly": true, "nullable": true, "description": "Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.\n" }, "prevPageToken": { "type": "string", "readOnly": true, "nullable": true, "description": "Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.\n" }, "results": { "type": "array", "readOnly": true, "description": "The result set from a collection API call.", "items": { "type": "object" } } }, "required": [ "nextPageToken", "prevPageToken", "results" ] }, "ApiV3Error": { "type": "object", "properties": { "code": { "description": "HTTP code defined in EEN Standard Code Values", "type": "integer" }, "status": { "description": "A string enum describing the code", "type": "string", "enum": [ "cancelled", "unknown", "invalidArgument", "deadlineExceeded", "notFound", "conflict", "permissionDenied", "resourceExhausted", "failedPrecondition", "aborted", "outOfRange", "unimplemented", "internal", "unavailable", "dataLoss", "unauthenticated", "mediaTypeNotSupported", "acceptNotSupported", "methodNotSupported", "tooManyRequests", "badGateway" ] }, "message": { "description": "Developer friendly human readable error message in English", "type": "string" }, "details": { "description": "An array of extensible objects that define error information", "type": "array", "items": { "$ref": "#/components/schemas/ExceptionDetail" } } }, "required": [ "code", "status", "message", "details" ] }, "ExceptionDetail": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ErrorInfoExceptionDetail" }, { "$ref": "#/components/schemas/BadRequestExceptionDetail" }, { "$ref": "#/components/schemas/ResourceInfoExceptionDetail" } ], "discriminator": { "propertyName": "type", "mapping": { "errorInfo": "#/components/schemas/ErrorInfoExceptionDetail", "badRequest": "#/components/schemas/BadRequestExceptionDetail", "resourceInfo": "#/components/schemas/ResourceInfoExceptionDetail" } }, "properties": { "type": { "description": "A string enum describing the type of detail object.", "type": "string", "enum": [ "errorInfo", "badRequest", "resourceInfo" ] } }, "required": [ "type" ] }, "ErrorInfoExceptionDetail": { "properties": { "type": { "description": "A string enum describing the type of detail object.", "type": "string", "enum": [ "errorInfo" ] }, "reason": { "description": "The reason for the error. This is a constant value that identifies the proximate cause of the\nerror. Error reasons are unique within a particular domain of errors.\n", "type": "string", "enum": [ "unauthenticated", "unexpectedArgument", "missingRequiredArgument", "wrongArgumentValue", "invalidPermission", "wrongEdition", "wrongAccountType", "resourceNotFound", "endpointNotFound", "methodNotSupported", "unexpectedError", "acceptNotSupported", "alreadyExists", "foreignKeyConflict", "childDevicesExist", "contentNotSupported", "deadlineExpired", "tooManyRequests", "deviceUnavailable", "serviceUnavailable", "invalidJSON", "resourceLocked", "notSupportedOnBridge", "outOfRetention", "deviceIdentificationFailed", "credentialValidationFailed", "credentialSetupFailed", "localUrlValidationFailed", "hwRegistrationFailed", "failedAddingCameraAfterValidation", "neverConnected", "reconnectFailed", "unsupportedModel", "purged", "userBlocked", "userTemporarilyBlocked", "quotaExceeded", "alreadyValidated", "reAuthenticationRequired", "badGateway" ] }, "domain": { "description": "Logical grouping to which the \"reason\" belongs\n", "type": "string" }, "metadata": { "$ref": "#/components/schemas/ExceptionMetadata" } } }, "BadRequestExceptionDetail": { "properties": { "type": { "description": "A string enum describing the type of detail object.", "type": "string", "enum": [ "badRequest" ] }, "argumentViolations": { "type": "array", "items": { "$ref": "#/components/schemas/ArgumentViolation" } } } }, "ArgumentViolation": { "properties": { "argumentName": { "type": "string", "description": "Name of the argument" }, "description": { "type": "string", "description": "Description of the violation" } } }, "ResourceInfoExceptionDetail": { "properties": { "type": { "description": "A string enum describing the type of detail object.", "type": "string", "enum": [ "resourceInfo" ] }, "resource": { "description": "Referenced resource type, eg \"cameras\", \"bridges\", or \"locations\".", "type": "string" }, "ids": { "type": "array", "description": "Identities of resources", "items": { "type": "string" } } } }, "ExceptionMetadata": { "properties": { "path": { "description": "Path of the request", "type": "string" }, "method": { "description": "Method of the request", "type": "string" } } }, "PaginatedLanguageResponse": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResponseWithSize" }, { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } } } } ] }, "Language": { "type": "object", "description": "Represents a langugage that is supported by the Eagle Eye Networks API.", "properties": { "tag": { "type": "string", "description": "IETF language tag used as main identifier of the language in the Eagle Eye Networks API. The format can be just the two character \"primary language subtag\" or a combination of the two character \"primary language subtag\" and 2 character \"region subtag\".\n", "example": "pt-BR", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }, "name": { "type": "string", "description": "Name of the language in native language, with an optional region in parentheses, eg. ‘Espanol’ for Spanish.\n", "example": "Português (Brasil)" } }, "required": [ "tag", "name" ] } }, "parameters": { "pageToken": { "in": "query", "name": "pageToken", "description": "Token string value that references a page for pagination. This value is received when retrieving the first page in the `nextPageToken` and `prevPageToken` fields.\nWhen a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like `include` should still be applied.\n", "example": "b2Zmc2V0PTEwJmxpbWl0PTEw", "required": false, "schema": { "type": "string" } }, "pageSize": { "in": "query", "name": "pageSize", "description": "The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a `nextPageToken` value.\n", "example": 100, "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 } } }, "responses": { "validationError": { "description": "The supplied object is invalid. Error detail will contain the validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV3Error" }, "examples": { "unexpectedArgument": { "value": { "code": 400, "status": "invalidArgument", "message": "Unexpected argument: name", "details": [ { "type": "errorInfo", "reason": "unexpectedArgument", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } } ] } }, "missingRequiredArgument": { "value": { "code": 400, "status": "invalidArgument", "message": "Missing required arguments: name, id", "details": [ { "type": "errorInfo", "reason": "missingRequiredArgument", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } } ] } }, "badRequestInvalidJSON": { "value": { "code": 400, "status": "invalidArgument", "message": "Invalid JSON", "details": [ { "type": "errorInfo", "reason": "invalidJSON", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } } ] } }, "badRequestInvalidArgument": { "value": { "code": 400, "status": "invalidArgument", "message": "Invalid Argument: Argument name is too long", "details": [ { "type": "errorInfo", "reason": "wrongArgumentValue", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } }, { "type": "badRequest", "argumentViolations": [ { "argumentName": "name", "description": "Name is too long" } ] } ] } } } } } }, "unauthorized": { "description": "You are not authenticated. Please authenticate and try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV3Error" }, "example": { "code": 401, "status": "unauthenticated", "message": "The client caller does not have a valid authentication credential", "details": [ { "type": "errorInfo", "reason": "unauthenticated", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } } ] } } } }, "internalServerError": { "description": "Something went wrong in the server. Please try again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV3Error" }, "example": { "code": 500, "status": "internal", "message": "An internal error has occurred. Please try again later.", "details": [ { "type": "errorInfo", "reason": "unexpectedError", "domain": "apiv3", "metadata": { "path": "/api/v3.0/" } } ] } } } } } }, "x-readme": { "explorer-enabled": true } } ```