# Crowdin API v1

## Operations

- [projects.directories.add(project, [options])](#projects-directories-add)
- [projects.directories.delete(project, [options])](#projects-directories-delete)
- [projects.files.add(project, [options])](#projects-files-add)
- [projects.files.update(project, [options])](#projects-files-update)
- [projects.files.export(project, [options])](#projects-files-export)
- [projects.getDetails(project, [options])](#projects-get-details)
- [projects.getTranslationStatus(project, [options])](#projects-get-translation-status)

<a id="projects-directories-add" href="#projects-directories-add">
  <h2>projects.directories.add(project, [options])</h2>
</a>

> Add a directory to your project.

**Parameters**

| name      | in    | required | description                                                                   |
| --------- | ----- | -------- | ----------------------------------------------------------------------------- |
| project   | path  | true     |                                                                               |
| key       | query | true     |                                                                               |
| name      | query | true     | Directory name (with path if nested directory should be created).             |
| recursive | query |          | Create directories recursively if a nested name is provided. Default is false |

<a id="projects-directories-delete" href="#projects-directories-delete">
  <h2>projects.directories.delete(project, [options])</h2>
</a>

> Delete a Crowdin project directory. All nested files and directories will be deleted too.

**Parameters**

| name    | in    | required | description                         |
| ------- | ----- | -------- | ----------------------------------- |
| project | path  | true     |                                     |
| name    | query | true     | Path to the directory to delete     |
| branch  | query |          | Name of the related version branch. |

<a id="projects-files-add" href="#projects-files-add">
  <h2>projects.files.add(project, [options])</h2>
</a>

> Add one or many files to your project.

**Parameters**

| name    | in    | required |
| ------- | ----- | -------- |
| project | path  | true     |
| key     | query | true     |

<a id="projects-files-update" href="#projects-files-update">
  <h2>projects.files.update(project, [options])</h2>
</a>

> Update one or many files in your project.

**Parameters**

| name    | in    | required |
| ------- | ----- | -------- |
| project | path  | true     |
| key     | query | true     |

<a id="projects-files-export" href="#projects-files-export">
  <h2>projects.files.export(project, [options])</h2>
</a>

> Export a single translated file from your project.

**Parameters**

| name     | in    | required | description                                                                                  |
| -------- | ----- | -------- | -------------------------------------------------------------------------------------------- |
| project  | path  | true     |                                                                                              |
| file     | query | true     | The path to the file that should be exported from the project.                               |
| language | query | true     | Crowdin language code. See https://support.crowdin.com/api/language-codes/                   |
| branch   | query |          | The name of the related version branch. See https://support.crowdin.com/versions-management/ |
| format   | query |          | Specify &#x60;xliff&#x60; to export file in the XLIFF file format.                                     |

<a id="projects-get-details" href="#projects-get-details">
  <h2>projects.getDetails(project, [options])</h2>
</a>

> Get project details.

**Parameters**

| name    | in    | required |
| ------- | ----- | -------- |
| project | path  | true     |
| key     | query | true     |

<a id="projects-get-translation-status" href="#projects-get-translation-status">
  <h2>projects.getTranslationStatus(project, [options])</h2>
</a>

> Get overall translation and proofreading progresses of each target language.

**Parameters**

| name    | in    | required |
| ------- | ----- | -------- |
| project | path  | true     |
| key     | query | true     |