Skip to content

Calibrate Map

POST
/api/creative/lore/maps/{map_id}/calibrate

Calibrate map scale using two reference points.

map_id
required
Map Id
string
CalibrateRequest

Two points on the map + real-world distance between them.

object
x1Pct
required
X1Pct
number
<= 100
y1Pct
required
Y1Pct
number
<= 100
x2Pct
required
X2Pct
number
<= 100
y2Pct
required
Y2Pct
number
<= 100
distance
required
Distance
number
> 0
unit
required
Unit
string
<= 50 characters

Successful Response

WorldMapResponse
object
id
required
Id
string
projectId
required
Projectid
string
title
required
Title
string
description
required
Description
string
imageFilename
required
Imagefilename
string
imageUrl
required
Imageurl
string
imageWidth
required
Imagewidth
integer
imageHeight
required
Imageheight
integer
imageSizeBytes
required
Imagesizebytes
integer
parentMapId
Any of:
string
parentMapTitle
Any of:
string
scalePixelsPerUnit
Any of:
number
scaleUnit
required
Scaleunit
string
pinCount
required
Pincount
integer
regionCount
required
Regioncount
integer
pathCount
required
Pathcount
integer
labelCount
required
Labelcount
integer
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object