Skip to content
getgeolens.com
GeoLens Docs

Get Pointcloud File

GET
/datasets/{dataset_id}/copc/{attempt_id}/{name}.copc.laz
 
curl --request GET \
  --url https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/copc/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/example.copc.laz

Serve a published COPC point cloud’s file, whole or by HTTP byte range.

Point a client at the dataset’s pointcloud.url. The path names the upload attempt, so a replaced file gets a new URL and the old one answers 404. Header credentials (X-Api-Key or Authorization) or the api_key query parameter authenticate the read, and any caller who can view the dataset can read the file. The response carries a strong ETag and honours Range, If-Range, If-Match and If-None-Match; a malformed byte range, or one naming no byte of the file, answers 416. Each client may make 1200 reads a minute. A read of one byte range of up to 16 MiB also draws its size on a budget of 1 GiB a minute, in 64 KiB units; any other read of the file, such as one without Range, counts against a limit of 10 a minute instead. Past any of these the read answers 429. A page on any origin can read a public file without credentials. Through the bundled web server it can also send header credentials; the API alone accepts those only from the origins in CORS_ALLOWED_ORIGINS. A private, missing or replaced point cloud answers 404, and a storage failure answers 502.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
dataset_id
required
Dataset Id
string format: uuid
attempt_id
required
Attempt Id
string format: uuid
name
required
Name
string

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The whole COPC file

Media type application/vnd.laszip+copc
string format: binary

206

Section titled “ 206 ”

One byte range of the COPC file

Media type application/vnd.laszip+copc
string format: binary

304

Section titled “ 304 ”

The caller already holds this version of the file

401

Section titled “ 401 ”

A credential was supplied and could not be resolved (expired, revoked or malformed); a read with none is anonymous

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Section titled “ 404 ”

Not found

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

412

Section titled “ 412 ”

Precondition failed — the caller’s If-Match no longer matches the current representation

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

416

Section titled “ 416 ”

The Range names no byte of the file, or is malformed

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Section titled “ 422 ”

Validation error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Section titled “ 429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “ Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “ 500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

502

Section titled “ 502 ”

Bad gateway — an upstream provider failed

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “ 503 ”

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string
Example 
{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}
Privacy Apache 2.0 getgeolens.com