Get the navigation mesh and any regeneration

GET

/{resource}/navmesh

curl --request GET \
  --url https://example.com/v1/example/navmesh \
  --header 'Authorization: Bearer <token>'

Authorizations

• token

Parameters

Path Parameters

resource

required

string

/^\d+$/

The project ID of the space

Responses

200

The navigation mesh’s state

Media typeapplication/json

object

job

required

One of:

object

object

id

required

string format: uuid

startedAt

required

When the job started, in milliseconds since the Unix epoch.

integer

status

required

string

Allowed values: running failed

error

Why the job failed.

string

stage

What a running job is doing.

string

Allowed values: loading generating uploading

null

null

generatedNavMesh

required

The document’s generatedNavMesh, or null if there isn’t one.

object | null

upToDate

required

Whether the navigation mesh was generated from the current map meshes. Changes to obstacles and settings aren’t tracked.

boolean

Example

{
  "job": {
    "status": "running",
    "stage": "loading"
  }
}

401

The token is missing or invalid.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

403

The token has no access to this space.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

429

Too many requests. Retry after Retry-After seconds.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

Headers

Retry-After

integer

Seconds to wait before retrying

502

Something upstream failed.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

503

The space is moving between servers. Retry after Retry-After seconds.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}

Headers

Retry-After

integer

Seconds to wait before retrying

504

Something upstream timed out.

Media typeapplication/json

object

error

required

A description of the error

string

code

required

A stable identifier for the kind of error

string

issues

For invalidBody: what failed validation, and where

Array<object>

object

Example ^generated

{
  "error": "example",
  "code": "example",
  "issues": [
    {}
  ]
}