# General Translation Platform: ファイル情報を取得
URL: https://generaltranslation.com/ja/docs/platform/openapi/reference/files/file-info.mdx
---

title: ファイル情報を取得
description: General Translation のソースファイルのメタデータ、バージョン、ロケール、翻訳状態を確認します。ファイル情報を取得するための API リファレンス。

method: POST
---

参照を指定して、ソースファイルおよび翻訳済みファイルのメタデータを返します。1 回のリクエストで、ソースファイル、翻訳済みファイル、またはその両方を照会できます。

## 概要 [#overview]

```http
POST https://api2.gtx.dev/v2/project/files/info
```

**権限** `project:files:read` · **レート制限** デフォルト (200/分) 

コンテンツをダウンロードせずにファイルのメタデータを参照できます。単一ファイルのロケールごとの翻訳進捗については、[Get translation status](/docs/platform/openapi/reference/files/translation-status)を使用してください。

## 仕組み [#how-it-works]

* `sourceFiles`、`translatedFiles`、または両方を指定します。各リストはそれぞれ独立して解決され、個別の配列として返されます。
* 返されるのは存在するファイルのみです。一致しない参照はエラーにならず、除外されます。
* レスポンスにはメタデータ (ロケール、形式、タイムスタンプ) のみが含まれ、ファイルの内容は含まれません。

## リクエスト [#request]

### ヘッダー

| ヘッダー              | 説明                                   | 必須  |
| ----------------- | ------------------------------------ | --- |
| `x-gt-api-key`    | プロジェクトまたはOrganizationのAPIキー。         | はい  |
| `x-gt-project-id` | プロジェクトID。Organizationキーを使用する場合に必要です。 | いいえ |

### 本文

**コンテンツタイプ** `application/json`

| Field             | Description      | 型          | 省略可能 | デフォルト |
| ----------------- | ---------------- | ---------- | ---- | ----- |
| `sourceFiles`     | 検索対象のソースファイル参照。   | `object[]` | はい   | —     |
| `translatedFiles` | 検索対象の翻訳済みファイル参照。 | `object[]` | はい   | —     |

各 `sourceFiles` 要素には `fileId`、`versionId`、`branchId` が必要です。各 `translatedFiles` 要素には `fileId`、`versionId`、`branchId`、`locale` が必要です。いずれの値も空にできません。

## レスポンス [#response]

**ステータス** `200 OK`

```json title="Response"
{
  "sourceFiles": [
    {
      "branchId": "br_...",
      "fileId": "file_...",
      "versionId": "ver_...",
      "fileName": "en/common.json",
      "fileFormat": "JSON",
      "dataFormat": "JSON",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "publishedAt": null,
      "locales": ["es", "fr"],
      "sourceLocale": "en"
    }
  ],
  "translatedFiles": [
    {
      "branchId": "br_...",
      "fileId": "file_...",
      "versionId": "ver_...",
      "fileFormat": "JSON",
      "dataFormat": "JSON",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "approvedAt": null,
      "publishedAt": null,
      "completedAt": "2026-01-01T00:00:00.000Z",
      "locale": "es"
    }
  ]
}
```

## エラー [#errors]

| ステータス | 原因                                       |
| ----- | ---------------------------------------- |
| `400` | ファイルクエリが無効です。                            |
| `401` | API キー が不足しているか、無効です。                   |
| `403` | API キー に `project:files:read` 権限がありません。 |
| `429` | レート制限を超えました。                             |

## 例 [#example]

```bash
curl -X POST https://api2.gtx.dev/v2/project/files/info \
  -H "x-gt-api-key: gtx-api-..." \
  -H "Content-Type: application/json" \
  -d '{
    "sourceFiles": [
      {
        "fileId": "file_...",
        "versionId": "ver_...",
        "branchId": "br_..."
      }
    ]
  }'
```