## Create structured sheet

`client.structuredSheets.create(StructuredSheetCreateParamsbody, RequestOptionsoptions?): StructuredSheetResponse`

**post** `/v1/structured-sheets`

Start converting a spreadsheet workbook into structured data. This initiates an asynchronous conversion process. Poll the returned resource using the `id` to check completion status.

### Parameters

- `body: StructuredSheetCreateParams`

  - `file_id: string`

    The unique identifier of the file to convert.

  - `sheet_names?: Array<string> | null`

    List of sheet names to convert. If None, all sheets will be converted.

### Returns

- `StructuredSheetResponse`

  Response representing a structured sheet conversion job.

  This is returned from POST (create), GET (retrieve), and list endpoints.

  - `id: string`

    The unique identifier for this structured sheet conversion.

  - `created_at: string`

    The timestamp when the conversion was started.

  - `file_id: string`

    The unique identifier for the source file.

  - `object: "structured_sheet"`

    The object type, which is always 'structured_sheet'.

    - `"structured_sheet"`

  - `status: "queued" | "in_progress" | "completed" | 2 more`

    The current processing status.

    - `"queued"`

    - `"in_progress"`

    - `"completed"`

    - `"failed"`

    - `"cancelled"`

  - `updated_at: string`

    The timestamp when the conversion was last updated.

  - `last_error?: LastError | null`

    Error information when processing fails.

    - `code: string`

      A machine-readable error code.

    - `message: string`

      A human-readable description of the error.

  - `sheet_names?: Array<string>`

    List of sheet names included in this conversion.

  - `table_count?: number | null`

    Number of tables extracted from the workbook. Only present when status is 'completed'.

### Example

```typescript
import DeepTable from '@deeptable/deeptable';

const client = new DeepTable({
  apiKey: process.env['DEEPTABLE_API_KEY'], // This is the default and can be omitted
});

const structuredSheetResponse = await client.structuredSheets.create({
  file_id: 'file_01h45ytscbebyvny4gc8cr8ma2',
});

console.log(structuredSheetResponse.id);
```

#### Response

```json
{
  "id": "ss_01kfxgjd94fn9stqm42nejb627",
  "created_at": "2024-01-15T10:30:00Z",
  "file_id": "file_01kfxgjd94fn9stqm414vjb0s8",
  "object": "structured_sheet",
  "status": "completed",
  "updated_at": "2024-01-15T10:35:00Z",
  "last_error": {
    "code": "invalid_file_format",
    "message": "The uploaded file is not a valid Excel spreadsheet."
  },
  "sheet_names": [
    "Sheet1",
    "Financials"
  ],
  "table_count": 6
}
```