Preview a character import

GET

/v1/imports/:import_id/preview

GET

/v1/imports/:import_id/preview

$ curl https://api.loreos.app/v1/imports/import_id/preview \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "import_id": "import_123abc456def",
3   "preview": {
4     "characters": [
5       {
6         "id": "char_789xyz123uvw",
7         "name": "Evelyn the Enchanter",
8         "description": "A wise and mysterious sorceress with a penchant for ancient magic.",
9         "traits": {
10           "alignment": "neutral good",
11           "age": 134,
12           "species": "Elf"
13         }
14       },
15       {
16         "id": "char_456def789ghi",
17         "name": "Gorak the Brave",
18         "description": "A fearless warrior from the northern tribes, known for his valor in battle.",
19         "traits": {
20           "alignment": "chaotic good",
21           "age": 29,
22           "species": "Human"
23         }
24       }
25     ],
26     "importStatus": "ready",
27     "importedAt": "2024-06-10T11:45:00Z",
28     "summary": "2 characters parsed successfully from the uploaded import file."
29   }
30 }

Authentication

AuthorizationBearer

LoreOS API key, sent as Authorization: Bearer <key>.

Path parameters

import_idstringRequired

Response

Successful Response

Errors

422

Unprocessable Entity Error