> ## Documentation Index > Fetch the complete documentation index at: https://developers.phrase.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a key > Create a new key. ## OpenAPI ````yaml /openapi/phrase-strings.json post /projects/{project_id}/keys openapi: 3.0.3 info: title: Phrase Strings API Reference version: 2.0.0 description: >- Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account. contact: name: Phrase Support url: https://developers.phrase.com/api/ email: support@phrase.com x-logo: url: https://developers.phrase.com/images/phrase-logo.svg backgroundColor: '#03eab3' altText: Phrase Strings termsOfService: https://phrase.com/terms/ license: name: MIT url: https://choosealicense.com/licenses/mit/ servers: - url: https://api.phrase.com/v2 description: EU production server - url: https://api.us.app.phrase.com/v2 description: US production server security: - Token: [] - Basic: [] tags: - name: Accounts - name: Authorizations description: > The endpoints provided by the Authorizations API are **only accessible via Basic authentication with email and password**. When creating a new authorization, the new access token for this authorization will be returned in the immediate response but not later, due to security reasons. When accessing authorizations later, you will only see the last eight chars of the token in plain text (`token_last_eight`) and the SHA256 digest of the token for reference (`hashed_token`). For instructions on how authorization in general works, see our [Auth Guide](#overview--authentication). ### Scopes When creating or updating an OAuth authorization, you can define a list of scopes to limit the access that can be performed by that authorization. #### Available Scopes
Scope Description
read Read projects, locales, keys, translations, orders
write Write projects, locales, keys, translations but not orders
orders.create Create and confirm orders
team.manage Manage invitations and members
- name: Blacklisted Keys - name: Branches description: > ### Branch creation Branches will be created asynchronously. State of branch creation is returned as state. #### Available States
State Description
initialized Data received.
processing Branch is currently creating.
success Branch was created successfully
error Branch creation failed.
- name: Comments - name: Comment Reactions - name: Comment Replies - name: Custom Metadata - name: Distributions - name: Documents - name: Figma Attachments - name: Formats - name: Glossaries - name: Glossary Terms - name: Glossary Term Translations - name: ICU - name: Invitations description: > With the invitation endpoint you can [manage and invite users](https://support.phrase.com/hc/en-us/articles/5709742418716) to Phrase Strings via API. A user can have the role Manager, Developer or Translator each with its own access rights. Developers and translators need resources like projects and locales assigned in order to access them. - name: Job Annotations description: > The job annotations endpoints allow you to create, update and delete annotations for jobs and job locales. Annotations are used to add metadata to a job or job locale. - name: Job Comments - name: Job Locales - name: Job Template Locales - name: Job Templates - name: Jobs - name: Keys - name: Linked Keys - name: Locales - name: Locale Downloads - name: Members description: > With the members endpoints you can do basic [team and user management](https://support.phrase.com/hc/en-us/articles/5709742418716) via API. A user can have the role Manager, Developer or Translator each with its own access rights. Developers and translators need resources like projects and locales assigned in order to access them. - name: Notifications - name: Notification Groups - name: Orders description: > ### List of categories [TextMaster] When ordering translations from TextMaster, you need to specify a category ID along with your order. See this list for information on the category ID and their equivalent description.
Category ID Description
C001Agriculture
C002Aerospace
C003Animals/Pets/Plants
C004Arts/Culture/Literature
C005Automotive/Transportation
C006Computers/Technology/Software
C007Telecom
C008Real Estate/Construction/Building
C009Consumer Goods
C010Education
C011Entertainment
C012Ecology/Environment
C013Health/Biotechnology/Pharma
C014Internet
C015Policy/Government/Public
C016Publishing/Media/Communication
C017Religion
C018Food/Beverages
C019Retail
C020Fashion/Luxury/Textiles
C021Travel/Tourism
C022Natural Resources/Energy
C023Banking/Financial Services/Insurance
C024Legal Affairs/Tax/Law
C025Raw Materials/Industrial Goods
C026Lifestyle/Leisure/Hobbies
C027Sports
C028Home/Family/Friends/Children
C029Economy/Financial Markets
C030Science
C031Human Resources/Employment
C032Adult (Pornography, Violence, etc.)
- name: Organization Job Template Locales - name: Organization Job Templates - name: Projects - name: Quality - name: Releases - name: Release Triggers - name: Repo Syncs description: > The Repo Syncs API allows you to synchronize your Phrase projects with your code repositories. You can import translations from your repository to Phrase and export translations from Phrase to your repository. - name: Repo Sync Events - name: Reports - name: Search - name: Screenshot Markers - name: Screenshots - name: Spaces - name: Style guides - name: Tags - name: Teams - name: Translations - name: Uploads description: > ### Formats We support all common localization file formats. For a detailed overview, see our [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364). ### Processing Uploads will be processed asynchronously and thus the data might not be imported yet although the upload is completed. Therefore we recommend to evaluate the returned state field for information on the import progress. #### Available States
State Description
initialized Data received.
waiting_for_preview Upload is waiting for preview to be finished.
waiting Upload is waiting for processing.
processing Upload is being processed, data is currently imported.
success Upload is complete and all data is imported.
error Upload or import process failed.
- name: Users - name: Variables - name: Versions / History - name: Webhooks - name: Webhook Deliveries paths: /projects/{project_id}/keys: post: tags: - Keys summary: Create a key description: Create a new key. operationId: key/create parameters: - $ref: '#/components/parameters/X-PhraseApp-OTP' - $ref: '#/components/parameters/project_id' requestBody: required: true content: application/json: schema: type: object title: key/create/parameters required: - name properties: branch: description: specify the branch to use type: string example: my-feature-branch name: description: Key name type: string example: home.index.headline description: description: >- Key description (usually includes contextual information for translators) type: string example: Some description worth knowing... plural: description: Indicates whether key supports pluralization type: boolean example: null use_ordinal_rules: description: Indicates whether key uses ordinal rules for pluralization type: boolean example: null name_plural: description: >- Plural name for the key (used in some file formats, e.g. Gettext) type: string example: home.index.headlines data_type: description: >- Type of the key. Can be one of the following: string, number, boolean, array, markdown. type: string example: number tags: description: >- List of tags separated by comma to be associated with the key. type: string example: awesome-feature,needs-proofreading max_characters_allowed: description: >- Max. number of characters translations for this key can have. type: integer example: 140 screenshot: description: >- Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. type: string format: binary example: /path/to/my/screenshot.png deprecated: true remove_screenshot: description: >- Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. type: boolean example: null deprecated: true unformatted: description: >- Indicates whether the key should be exported as "unformatted". Supported by Android XML and other formats. type: boolean example: null default_translation_content: description: >- Creates a translation in the default locale with the specified content type: string example: Default translation content autotranslate: description: >- Indicates whether the key should be autotranslated to other locales based on the copy provided in `default_translation_content`. type: boolean example: null xml_space_preserve: description: >- Indicates whether the key should be exported with "xml:space=preserve". Supported by several XML-based formats. type: boolean example: null original_file: description: Original file attribute. Used in some formats, e.g. XLIFF. type: string example: null localized_format_string: description: >- NSStringLocalizedFormatKey attribute. Used in .stringsdict format. type: string example: null localized_format_key: description: >- NSStringLocalizedFormatKey attribute. Used in .stringsdict format. type: string example: null custom_metadata: description: >- Custom metadata property name and value pairs to be associated with key. type: object example: fruit: Apple vegetable: Tomato responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/translation_key_details' headers: X-Rate-Limit-Limit: $ref: '#/components/headers/X-Rate-Limit-Limit' X-Rate-Limit-Remaining: $ref: '#/components/headers/X-Rate-Limit-Remaining' X-Rate-Limit-Reset: $ref: '#/components/headers/X-Rate-Limit-Reset' '400': $ref: '#/components/responses/400' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' x-code-samples: - lang: Curl source: |- curl "https://api.phrase.com/v2/projects/:project_id/keys" \ -u USERNAME_OR_ACCESS_TOKEN \ -X POST \ -F branch=my-feature-branch \ -F name=home.index.headline \ -F description=Some%20description%20worth%20knowing... \ -F name_plural=home.index.headlines \ -F data_type=number \ -F tags=awesome-feature,needs-proofreading \ -F max_characters_allowed=140 \ -F screenshot=@/path/to/my/screenshot.png -F custom_metadata[property]=value - lang: CLI v2 source: >- phrase keys create \ --project_id \ --data '{"branch":"my-feature-branch", "name":"home.index.headline", "description": "Some description worth knowing...", "name_plural":"home.index.headlines", "data_type":"number", "tags":"awesome-feature,needs-proofreading", "max_characters_allowed":"140", "screenshot":"/path/to/my/screenshot.png", "custom_metadata": {"property" => "value"}}' \ --access_token components: parameters: X-PhraseApp-OTP: in: header name: X-PhraseApp-OTP description: Two-Factor-Authentication token (optional) required: false allowEmptyValue: false schema: type: string project_id: in: path name: project_id description: Project ID required: true schema: type: string schemas: translation_key_details: allOf: - $ref: '#/components/schemas/translation_key' - type: object title: translation_key_details properties: name_plural: type: string comments_count: type: integer max_characters_allowed: type: integer screenshot_url: type: string unformatted: type: boolean xml_space_preserve: type: boolean original_file: type: string format_value_type: type: string creator: $ref: '#/components/schemas/user_preview' custom_metadata: type: object title: custom_metadata additionalProperties: type: string example: name_plural: home.index.headlines comments_count: 2 data_type: string max_characters_allowed: 140 screenshot_url: http://assets.example.com/screenshot.png unformatted: false xml_space_preserve: false original_file: '' format_value_type: '' creator: id: abcd1234cdef1234abcd1234cdef1234 username: joe.doe name: Joe Doe custom_metadata: fruit: Apple vegetable: Tomato translation_key: type: object title: translation_key properties: id: type: string name: type: string description: type: string name_hash: type: string plural: type: boolean use_ordinal_rules: type: boolean tags: type: array items: type: string data_type: type: string created_at: type: string format: date-time updated_at: type: string format: date-time example: id: abcd1234cdef1234abcd1234cdef1234 name: home.index.headline description: My description for this key... name_hash: 1b31d2580ce324f246f66b3be00ed399 plural: false use_ordinal_rules: false tags: - awesome-feature - needs-proofreading data_type: string created_at: '2015-01-28T09:52:53Z' updated_at: '2015-01-28T09:52:53Z' user_preview: type: object title: user_preview properties: id: type: string username: type: string name: type: string gravatar_uid: type: string example: id: abcd1234cdef1234abcd1234cdef1234 username: johndoe name: John Doe gravatar_uid: 205e460b479e2e5b48aec07710c08d50 headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period schema: type: integer X-Rate-Limit-Remaining: description: The number of remaining requests in the current period schema: type: integer X-Rate-Limit-Reset: description: >- Timestamp of end of current time period as UNIX timestamp, see [Rate Limiting](/en/api/strings/pagination#rate-limiting) schema: type: integer responses: '400': description: Bad request headers: X-Rate-Limit-Limit: $ref: '#/components/headers/X-Rate-Limit-Limit' X-Rate-Limit-Remaining: $ref: '#/components/headers/X-Rate-Limit-Remaining' X-Rate-Limit-Reset: $ref: '#/components/headers/X-Rate-Limit-Reset' '404': description: Not Found headers: X-Rate-Limit-Limit: $ref: '#/components/headers/X-Rate-Limit-Limit' X-Rate-Limit-Remaining: $ref: '#/components/headers/X-Rate-Limit-Remaining' X-Rate-Limit-Reset: $ref: '#/components/headers/X-Rate-Limit-Reset' '429': description: Rate Limiting headers: X-Rate-Limit-Limit: $ref: '#/components/headers/X-Rate-Limit-Limit' X-Rate-Limit-Remaining: $ref: '#/components/headers/X-Rate-Limit-Remaining' X-Rate-Limit-Reset: $ref: '#/components/headers/X-Rate-Limit-Reset' securitySchemes: Token: type: apiKey in: header name: Authorization description: Enter your token in the format `token TOKEN` Basic: type: http scheme: basic ````