# Import a Plotwork diagram

> Page: https://docs.flung.dev/reference/api/post-v1-plotwork-diagrams-id-import. Index of every page: https://docs.flung.dev/llms.txt

Has Plotwork paint the diagram as a PNG, keeps it as a media file with alt text, and answers the file, `ready`: put its id in a post's `mediaIds`.

`POST /v1/plotwork/diagrams/{id}/import`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Import a Plotwork diagram. |
| What does it need? | An API key or an OAuth access token. |
| What does it take? | A JSON body with the fields below, and `id` in the path, and `idempotency-key` in a header. |
| What does it return? | Status 201 with a body of type [`Media`](https://docs.flung.dev/reference/api/schemas.md#media). |
| In the SDK? | `flung.plotwork.importDiagram()` |
| As an MCP tool? | [`attach_plotwork_diagram`](https://docs.flung.dev/mcp/tools/attach-plotwork-diagram.md) |
| What can go wrong? | `401` Missing, unknown, revoked or expired API key; `404` No such diagram in the connected account; `409` Plotwork is not connected (`plotwork_not_connected`), or must be connected again (`plotwork_reconnect`), in the portal; `422` The request failed validation; `429` Too many requests for this credential; wait for `retry-after` seconds; `502` Plotwork could not be reached or refused for a moment (`plotwork_unavailable`); `503` Plotwork is not set up on this server (`not_configured`). Every failure has the same [error shape](https://docs.flung.dev/reference/api/errors.md). |

## Example

**curl**

```bash
curl -X POST 'https://api.flung.dev/v1/plotwork/diagrams/0b7e3c1a-5d2f-4c88-9a41-6f0e2d9b7c35/import' \
  --header "Authorization: Bearer $FLUNG_API_KEY" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $(uuidgen)" \
  --data '{}'
```

**TypeScript**

```ts
import { Flung } from '@flung.dev/sdk'

const flung = new Flung({ apiKey: process.env.FLUNG_API_KEY! })
const result = await flung.plotwork.importDiagram({
  id: '0b7e3c1a-5d2f-4c88-9a41-6f0e2d9b7c35',
})
```

**fetch**

```js
const response = await fetch('https://api.flung.dev/v1/plotwork/diagrams/0b7e3c1a-5d2f-4c88-9a41-6f0e2d9b7c35/import', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.FLUNG_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({}),
})
if (!response.ok) throw new Error((await response.json()).error.message)
const result = await response.json()
```

A successful answer looks like this:

```json
{
  "id": "med_aaaaaaaaaaaaaaaaaaaaaaaa",
  "contentType": "image/jpeg",
  "filename": "string",
  "altText": "string",
  "bytes": 1,
  "status": "pending",
  "preview": {
    "status": "processing",
    "thumbnailUrl": "string",
    "hlsUrl": "string",
    "dashUrl": "string",
    "durationSeconds": 1
  },
  "createdAt": "2026-11-01T09:00:00.000Z"
}
```

## Path parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | `string` | yes | A diagram id from the list. |

## Header parameters

| Field | Type | Required | Description |
|---|---|---|---|
| `idempotency-key` | `string` | no | Any unique string, such as a UUID. A retry with the same key and body within 24 hours gets the first answer instead of running again. |

## Request body

The body has the type an object, with the fields below.

| Field | Type | Required | Description |
|---|---|---|---|
| `scheme` | `"light" \| "dark"` | no | Painted light or dark. A picture drawn for one scheme keeps it. default "light". |
| `width` | `integer` | no | The width in pixels; 1600 suits every network. minimum 800; maximum 2400; default 1600. |
| `altText` | `string` | no | Defaults to the diagram's name. at least 1 character; at most 1000 characters. |

## Responses

| Status | Meaning | Body |
|---|---|---|
| 201 | The media file, `ready`. | [`Media`](https://docs.flung.dev/reference/api/schemas.md#media) |
| 401 | Missing, unknown, revoked or expired API key. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 404 | No such diagram in the connected account. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 409 | Plotwork is not connected (`plotwork_not_connected`), or must be connected again (`plotwork_reconnect`), in the portal. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 422 | The request failed validation. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 429 | Too many requests for this credential; wait for `retry-after` seconds. | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 502 | Plotwork could not be reached or refused for a moment (`plotwork_unavailable`). | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |
| 503 | Plotwork is not set up on this server (`not_configured`). | [`Error`](https://docs.flung.dev/reference/api/schemas.md#error) |

## Response body

A 201 answer has the type [`Media`](https://docs.flung.dev/reference/api/schemas.md#media).

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | `string` | yes |  |
| `contentType` | `MediaType` | yes | What the file really is, read from its first bytes once uploaded. |
| `filename` | `string \| null` | yes |  |
| `altText` | `string \| null` | yes | The alt text the file was imported with, such as a Plotwork diagram's name. Null for an upload. |
| `bytes` | `integer \| null` | yes |  |
| `status` | `"pending" \| "processing" \| "ready" \| "failed"` | yes | `pending` until its bytes arrive; `ready` once a post can use it. |
| `preview` | `object \| null` | yes | Videos only, where previews are set up: a thumbnail. Read the file again while `processing`. |
| `preview.status` | `"processing" \| "ready" \| "failed" \| "skipped"` | yes | `skipped` when the video is over 100 MB or this month's thumbnail allowance is used up. Posts never wait for a preview; they use the file as uploaded. |
| `preview.thumbnailUrl` | `string \| null` | yes | A JPEG frame one second in, 640 pixels wide, at an address that does not expire. |
| `preview.hlsUrl` | `string \| null` | yes | Always null for now: streaming versions are not made. |
| `preview.dashUrl` | `string \| null` | yes | Always null for now. |
| `preview.durationSeconds` | `number \| null` | yes | Always null for now. |
| `createdAt` | `string` | yes |  |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.flung.dev/reference/api.md) | Every endpoint |
| [Schemas](https://docs.flung.dev/reference/api/schemas.md) | Every request and response type |
| [Errors](https://docs.flung.dev/reference/api/errors.md) | Every error code and what to do about it |
| [`attach_plotwork_diagram`](https://docs.flung.dev/mcp/tools/attach-plotwork-diagram.md) | The same operation as an MCP tool |