# Retrieve project capabilities

`GET https://api.lingohub.com/v2/projects/{projectId}/capabilities`

LingoHub API V2 (Beta) · [Capabilities](https://developers.lingohub.com/reference/v2/operations/tags/capabilities.md) · operation `getProjectCapabilities`

Returns the project's type, the largest file it imports and its native file formats with their extensions, and whether files and keys can be created in each format without an upload. It doesn't list the project's files. Requires project-level resource view permission.

## Parameters

| Parameter | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `projectId` | path | yes | string |  |

## Example request

```sh
curl --request GET \
  --url https://api.lingohub.com/v2/projects/PROJECT_ID/capabilities \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Responses

- `200`: Project capabilities retrieved.
- `400`: 
- `401`: 
- `403`: 
- `404`: 
- `429`: 
- `500`: 
- `503`: 

## OpenAPI definition

The complete definition of this operation, with every schema it references:

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "LingoHub API V2 (Beta)",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.lingohub.com",
      "description": "LingoHub"
    }
  ],
  "tags": [
    {
      "name": "Capabilities",
      "description": "Read the file formats a project uses and the largest file it imports."
    }
  ],
  "paths": {
    "/v2/projects/{projectId}/capabilities": {
      "get": {
        "tags": [
          "Capabilities"
        ],
        "summary": "Retrieve project capabilities",
        "description": "Returns the project's type, the largest file it imports and its native file formats with their extensions, and whether files and keys can be created in each format without an upload. It doesn't list the project's files. Requires project-level resource view permission.",
        "operationId": "getProjectCapabilities",
        "parameters": [
          {
            "name": "projectId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
              "pattern": "^pr_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Project capabilities retrieved.",
            "headers": {
              "ETag": {
                "$ref": "#/components/headers/ETag"
              },
              "RateLimit": {
                "$ref": "#/components/headers/RateLimit"
              },
              "RateLimit-Policy": {
                "$ref": "#/components/headers/RateLimit-Policy"
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Capabilities"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "429": {
            "$ref": "#/components/responses/TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "headers": {
      "ETag": {
        "description": "Opaque strong validator for this representation. Keep its quotation marks and use it as If-Match on a documented conditional write. A replay carries the original ETag, which may now be stale.",
        "schema": {
          "type": "string"
        }
      },
      "RateLimit": {
        "description": "State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with `r` = requests remaining right now and `t` = seconds until the full quota is available again. Example: `\"api-key\";r=42;t=7`. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.",
        "schema": {
          "type": "string"
        }
      },
      "RateLimit-Policy": {
        "description": "The rate-limit policies applied to the request: each quoted policy name with `q` = sustained request quota per window of `w` seconds. Example: `\"api-key\";q=180;w=60, \"workspace\";q=600;w=60`. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.",
        "schema": {
          "type": "string"
        }
      },
      "Retry-After": {
        "description": "Seconds to wait before retrying.",
        "schema": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "schemas": {
      "Capabilities": {
        "type": "object",
        "description": "What a project accepts: its type, the largest file it imports and its native file formats. Computed from the project type, so it has no timestamps.",
        "properties": {
          "object_type": {
            "type": "string",
            "description": "Always `CAPABILITIES`.",
            "enum": [
              "CAPABILITIES"
            ],
            "example": "CAPABILITIES"
          },
          "project_id": {
            "type": "string",
            "description": "The project these capabilities belong to.",
            "example": "pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
            "pattern": "^pr_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
          },
          "project_type": {
            "$ref": "#/components/schemas/ProjectType",
            "description": "The project's type."
          },
          "max_import_file_bytes": {
            "type": "integer",
            "format": "int64",
            "description": "Largest file the project imports, in bytes. Applies to each file inside a ZIP archive too.",
            "example": 10485760
          },
          "resource_formats": {
            "type": "array",
            "description": "The project's native file formats.",
            "example": [
              {
                "format": "ANDROID_XML",
                "extensions": [
                  ".xml"
                ],
                "is_standalone_creation_available": true,
                "is_segment_creation_available": true
              }
            ],
            "items": {
              "$ref": "#/components/schemas/FormatCapabilities"
            }
          }
        },
        "required": [
          "max_import_file_bytes",
          "object_type",
          "project_id",
          "project_type",
          "resource_formats"
        ]
      },
      "ProjectType": {
        "type": "string",
        "description": "The project's file format, or the platform it syncs with (for example `CONTENTFUL` or `ZENDESK`). It decides which files the project accepts and can't be changed after creation.",
        "enum": [
          "ANDROID_XML",
          "IOS_STRINGS",
          "IOS_STRINGS_CATALOG",
          "STANDARD_PROPERTIES",
          "GETTEXT_PO",
          "WINDOWS_RESX",
          "QT_LINGUIST_TS",
          "DEFINE_PHP",
          "STANDARD_INI",
          "STANDARD_ARB",
          "RAILS_YAML",
          "SYMFONY_YAML",
          "STANDARD_JSON",
          "ANGULAR_TRANSLATE_JSON",
          "CHROME_I18N_JSON",
          "GO_I18N_JSON",
          "I18NEXT_JSON",
          "REACT_INTL_JSON",
          "STANDARD_CSV",
          "SINGLE_LANGUAGE_CSV",
          "KEY_VALUE_CSV",
          "STANDARD_XLIFF",
          "STANDARD_XLIFF_2",
          "STANDARD_TXT",
          "TWINE_TXT",
          "STANDARD_MARKDOWN",
          "STANDARD_HTML",
          "FIGMA",
          "ZENDESK",
          "STORYBLOK",
          "STORYBLOK_JSON",
          "CONTENTFUL",
          "SUBTITLE_SRT",
          "SUBTITLE_VTT",
          "HUBSPOT",
          "STRIPO",
          "CRISP_HELPDESK",
          "DOCUMENT",
          "VUE_I18N_JSON"
        ],
        "example": "STANDARD_JSON"
      },
      "FormatCapabilities": {
        "type": "object",
        "description": "File-format support in this deployment; does not guarantee that a particular file is valid.",
        "properties": {
          "format": {
            "$ref": "#/components/schemas/ResourceFormat",
            "description": "Resource format."
          },
          "extensions": {
            "type": "array",
            "description": "Accepted filename extensions with leading dots, matched case-insensitively. Empty for formats without a file reader.",
            "example": [
              ".xml"
            ],
            "items": {
              "type": "string"
            }
          },
          "is_standalone_creation_available": {
            "type": "boolean",
            "description": "Whether an empty native file can be created without an uploaded original. The selected project must also allow this format. This does not assert manual source editing support for every format.",
            "example": true
          },
          "is_segment_creation_available": {
            "type": "boolean",
            "description": "Whether createKey and createKeysBulk can create independent source segments in this format. False for single-language CSV, which requires complete rows; existing imported-cell text edits remain supported. The current project and permissions must also permit creation.",
            "example": true
          }
        },
        "required": [
          "extensions",
          "format",
          "is_segment_creation_available",
          "is_standalone_creation_available"
        ]
      },
      "ResourceFormat": {
        "type": "string",
        "description": "The file format of a resource. Determines how the file is parsed on import and rendered on export. Folders have no format.",
        "enum": [
          "ANDROID_XML",
          "IOS_STRINGS",
          "IOS_STRINGSDICT",
          "IOS_STRINGS_CATALOG",
          "STANDARD_PROPERTIES",
          "GETTEXT_PO",
          "WINDOWS_RESX",
          "QT_LINGUIST_TS",
          "DEFINE_PHP",
          "STANDARD_INI",
          "STANDARD_ARB",
          "RAILS_YAML",
          "SYMFONY_YAML",
          "STANDARD_JSON",
          "STORYBLOK_JSON",
          "ANGULAR_TRANSLATE_JSON",
          "CHROME_I18N_JSON",
          "GO_I18N_JSON",
          "I18NEXT_JSON",
          "REACT_INTL_JSON",
          "STANDARD_CSV",
          "SINGLE_LANGUAGE_CSV",
          "KEY_VALUE_CSV",
          "STANDARD_XLIFF",
          "STANDARD_XLIFF_2",
          "STANDARD_TXT",
          "TWINE_TXT",
          "STANDARD_MARKDOWN",
          "STANDARD_HTML",
          "FIGMA",
          "ZENDESK",
          "STORYBLOK",
          "CONTENTFUL",
          "SUBTITLE_SRT",
          "SUBTITLE_VTT",
          "HUBSPOT",
          "STRIPO",
          "CRISP_HELPDESK",
          "DOCX",
          "PPTX",
          "ODT",
          "ODP",
          "VUE_I18N_JSON"
        ]
      },
      "Error": {
        "type": "object",
        "description": "RFC 9457 problem details. `code` identifies the problem type (one per `type` URL); `errors` lists rejected fields or parameters; `required_permission` names the permission a 403 lacked.",
        "properties": {
          "type": {
            "type": "string",
            "description": "URL identifying the problem type and pointing to its documentation.",
            "example": "https://api.lingohub.com/errors/resource-not-found"
          },
          "title": {
            "type": "string",
            "description": "Short, constant summary of the problem type.",
            "example": "Resource not found"
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "HTTP status code.",
            "example": 404
          },
          "detail": {
            "type": "string",
            "description": "Human-readable explanation of this occurrence of the problem.",
            "example": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found."
          },
          "instance": {
            "type": "string",
            "description": "Path of the request that produced the problem.",
            "example": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde"
          },
          "code": {
            "$ref": "#/components/schemas/ErrorCode",
            "description": "Machine-readable problem type.",
            "example": "resource_not_found"
          },
          "request_id": {
            "type": "string",
            "description": "Correlation id of the request, also returned in the `X-Request-ID` header. Quote it when contacting support.",
            "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
          },
          "errors": {
            "type": "array",
            "description": "Rejected fields or parameters. Present when the problem concerns specific fields or parameters.",
            "example": [
              {
                "detail": "must be at least 2 characters long",
                "pointer": "#/name",
                "parameter": "limit",
                "code": "minLength"
              }
            ],
            "items": {
              "$ref": "#/components/schemas/FieldError"
            }
          },
          "required_permission": {
            "$ref": "#/components/schemas/RequiredPermission",
            "description": "The permission the API key lacks. Present on 403 responses."
          }
        },
        "required": [
          "code",
          "detail",
          "instance",
          "request_id",
          "status",
          "title",
          "type"
        ]
      },
      "ErrorCode": {
        "type": "string",
        "description": "Machine-readable problem type of a V2 error response. Each code has a fixed HTTP status and documentation at its `type` URL.",
        "enum": [
          "invalid_json",
          "invalid_parameter",
          "missing_parameter",
          "unknown_parameter",
          "invalid_filter",
          "invalid_cursor",
          "bad_request",
          "missing_api_key",
          "invalid_api_key",
          "expired_api_key",
          "revoked_api_key",
          "disabled_api_key",
          "insufficient_permissions",
          "resource_not_found",
          "route_not_found",
          "method_not_allowed",
          "not_acceptable",
          "precondition_failed",
          "content_too_large",
          "unsupported_media_type",
          "already_exists",
          "idempotency_outcome_unknown",
          "idempotency_key_in_use",
          "stack_not_empty",
          "branch_not_ready",
          "backup_not_ready",
          "backup_in_use",
          "default_branch_protected",
          "owner_membership_protected",
          "source_language_protected",
          "branch_limit_reached",
          "context_image_limit_reached",
          "automation_limit_reached",
          "translation_order_pending",
          "git_integration_not_configured",
          "branch_git_integration_not_configured",
          "git_integration_unauthorized",
          "conflict",
          "validation_failed",
          "idempotency_key_mismatch",
          "rate_limit_exceeded",
          "internal_error",
          "upstream_error",
          "service_unavailable",
          "upstream_timeout"
        ]
      },
      "FieldError": {
        "type": "object",
        "description": "A rejected field or parameter. `pointer` locates a body field (RFC 6901 JSON Pointer), `parameter` a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as `filter`.",
        "properties": {
          "detail": {
            "type": "string",
            "description": "Human-readable description of the problem.",
            "example": "must be at least 2 characters long"
          },
          "pointer": {
            "type": [
              "string",
              "null"
            ],
            "description": "JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.",
            "example": "#/name"
          },
          "parameter": {
            "type": [
              "string",
              "null"
            ],
            "description": "Name of the offending query, path or header parameter, or of the multipart form field.",
            "example": "limit"
          },
          "code": {
            "$ref": "#/components/schemas/FieldErrorCode",
            "description": "Why the field or parameter was rejected.",
            "example": "minLength"
          }
        },
        "required": [
          "code",
          "detail",
          "parameter",
          "pointer"
        ]
      },
      "FieldErrorCode": {
        "type": "string",
        "description": "Why a field or parameter was rejected: the JSON Schema keyword of the violated rule, or one of the documented rules that no schema can express.",
        "enum": [
          "required",
          "type",
          "enum",
          "minLength",
          "maxLength",
          "minimum",
          "maximum",
          "pattern",
          "format",
          "additionalProperties",
          "minItems",
          "maxItems",
          "uniqueItems",
          "already_exists",
          "not_found",
          "not_supported",
          "unsupported_file_extension",
          "file_too_large",
          "file_empty",
          "invalid_archive",
          "empty_archive"
        ]
      },
      "RequiredPermission": {
        "type": "object",
        "description": "The permission the API key lacks, in the vocabulary of the API key permission settings.",
        "properties": {
          "scope": {
            "$ref": "#/components/schemas/PermissionScope",
            "description": "Where the permission applies.",
            "example": "STACK"
          },
          "target": {
            "$ref": "#/components/schemas/PermissionTarget",
            "description": "The area the permission governs.",
            "example": "SETTINGS"
          },
          "level": {
            "$ref": "#/components/schemas/PermissionLevel",
            "description": "The access level required.",
            "example": "MANAGE"
          }
        },
        "required": [
          "level",
          "scope",
          "target"
        ]
      },
      "PermissionScope": {
        "type": "string",
        "description": "Where a permission applies: `WORKSPACE` permissions cover workspace-level resources, `STACK` permissions the resources of a stack (its projects, branches, resources, languages, ...).",
        "enum": [
          "WORKSPACE",
          "STACK"
        ]
      },
      "PermissionTarget": {
        "type": "string",
        "description": "The area a permission governs.",
        "enum": [
          "GENERAL",
          "BILLING_SUBSCRIPTION",
          "WORKSPACES",
          "MEMBERS",
          "PLUGINS_INTEGRATIONS",
          "LOGS",
          "API_ACCESS",
          "STACKS",
          "TRANSLATION_ORDERS",
          "WORK_REPORTS",
          "STYLE_GUIDES",
          "GLOSSARIES",
          "TRANSLATION_MEMORIES",
          "LABELS",
          "AI_TRANSLATION",
          "QUICK_TRANSLATIONS",
          "SETTINGS",
          "ACTIVITIES",
          "RESOURCES",
          "CONTEXT_IMAGES",
          "LANGUAGES",
          "SEGMENT_KEYS",
          "SEGMENTS",
          "SEGMENT_TEXTS"
        ]
      },
      "PermissionLevel": {
        "type": "string",
        "description": "Access level of a permission: `MANAGE` includes `WRITE` and `VIEW`.",
        "enum": [
          "NO_ACCESS",
          "VIEW",
          "WRITE",
          "MANAGE"
        ]
      }
    },
    "responses": {
      "BadRequest": {
        "description": "The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. `code` names the problem, `errors` the parameter or field.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Invalid or missing API key.",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Insufficient permissions.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "NotFound": {
        "description": "The resource does not exist, or the API key cannot see it.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "TooManyRequests": {
        "description": "The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.",
        "headers": {
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "InternalServerError": {
        "description": "An unexpected internal server error occurred.",
        "headers": {
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "ServiceUnavailable": {
        "description": "The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.",
        "headers": {
          "Retry-After": {
            "$ref": "#/components/headers/Retry-After"
          },
          "RateLimit": {
            "$ref": "#/components/headers/RateLimit"
          },
          "RateLimit-Policy": {
            "$ref": "#/components/headers/RateLimit-Policy"
          }
        },
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "description": "API key authentication. Create API keys in your LingoHub workspace settings. Keys use the `lh-api_` prefix. Pass the full key as the Bearer token.",
        "scheme": "bearer"
      }
    }
  }
}
````
