# generaltranslation: General Translation Core SDK: setupProject
URL: https://generaltranslation.com/es/docs/core/class/methods/translation/setup-project.mdx
---
title: setupProject
description: Referencia de la API del método setupProject para inicializar la configuración del proyecto de traducción
---

## Resumen

El método `setupProject` inicializa el proceso de configuración de un proyecto de traducción con archivos previamente cargados.
Esto crea una tarea de configuración asíncrona que analiza los archivos y los prepara para los flujos de trabajo de traducción.

```typescript
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const setupResult = await gt.setupProject(fileRefs, { timeout: 30000 });
console.log(`Setup job created: ${setupResult.jobId}`);
```

<Callout type="info">
  Debes haber cargado previamente los archivos de origen con [`uploadSourceFiles`](/docs/core/class/methods/translation/upload-source-files) antes de llamar a `setupProject`.
</Callout>


## Referencia

### Parámetros

| nombre     | Tipo                  | Descripción                                                    |
| ---------- | --------------------- | -------------------------------------------------------------- |
| `files`    | `FileReference[]`     | array de referencias a archivos de origen cargados previamente |
| `options?` | `SetupProjectOptions` | Configuración opcional para la tarea de configuración          |

#### Estructura de FileReference

```typescript
type FileReference = {
  fileId: string;
  versionId: string;
  branchId: string;
  fileName: string;
  fileFormat?: FileFormat;
  dataFormat?: DataFormat;
}
```


#### SetupProjectOptions

| Nombre     | Tipo       | Descripción                                                          |
| ---------- | ---------- | -------------------------------------------------------------------- |
| `locales?` | `string[]` | Array opcional de locales de destino                                 |
| `timeout?` | `number`   | Tiempo de espera opcional en milisegundos para la solicitud a la API |

### Devuelve

`Promise<SetupProjectResult>`: contiene el identificador de la tarea de configuración y el estado inicial.

```typescript
type SetupProjectResult = {
  jobId: string;
  status: 'queued';
}
```

| Propiedad | Tipo       | Descripción                                      |
| --------- | ---------- | ------------------------------------------------ |
| `jobId`   | `cadena`   | Identificador único de la tarea de configuración |
| `status`  | `'queued'` | Estado inicial de la tarea de configuración      |

***


## Ejemplos

### Uso básico

Inicializa la configuración del proyecto con los archivos cargados:

```typescript title="index.ts" copy
import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key'
});

// Referencia a archivo de la carga anterior
const fileRefs = [
  {
    fileId: 'file-123',
    versionId: 'version-456',
    branchId: 'branch-789',
    fileName: 'app.json',
    fileFormat: 'JSON'
  },
  {
    fileId: 'file-789',
    versionId: 'version-012',
    branchId: 'branch-789',
    fileName: 'content.md',
    fileFormat: 'MD'
  }
];

const setupResult = await gt.setupProject(fileRefs);
console.log(`Setup initiated with job ID: ${setupResult.jobId}`);

// Supervisar el estado del trabajo
const jobStatus = await gt.checkJobStatus([setupResult.jobId]);
console.log(`Job status: ${jobStatus.jobs[0].status}`);
```

***


## Notas

* Los archivos deben cargarse con [`uploadSourceFiles`](/docs/core/class/methods/translation/upload-source-files) antes de llamar a `setupProject`
* La configuración del proyecto analiza el contenido y la estructura de los archivos para optimizar los flujos de trabajo de traducción
* La tarea de configuración se ejecuta de forma asíncrona; supervisa el progreso con [`checkJobStatus`](/docs/core/class/methods/translation/check-job-status)
* La configuración suele ser necesaria antes de poner en cola trabajos de traducción para proyectos nuevos
* Las referencias a archivos incluyen `branchId` para un versionado adecuado con compatibilidad con branching

## Siguientes pasos

* Consulta [`uploadSourceFiles`](/docs/core/class/methods/translation/upload-source-files) para cargar archivos antes de la configuración
* Consulta [`checkJobStatus`](/docs/core/class/methods/translation/check-job-status) para supervisar el progreso de la configuración
* Consulta [`enqueueFiles`](/docs/core/class/methods/translation/enqueue-files) para iniciar las traducciones después de la configuración