Create a new item

POST

/{model}/items

• Public API endpoint

Submit a new item to the specified model. The created item is unpublished (Draft) and will not appear in the public read API until it is published. Only available when posting is enabled for both the project and the model. Rate-limited per IP; when the limit is exceeded, a Retry-After header indicates how many seconds to wait before retrying.

Authorizations

• None
• apiKey

Parameters

Path Parameters

model

required

string

Model ID or key

Request Body ^required

object

fields

Field values keyed by field key. Fields of type Asset, Reference, Tag, Group, GeometryEditor, and GeometryObject are not supported for posting and are ignored; if such a field is required by the model, posting is rejected entirely.

object

Responses

202

Item accepted and created as unpublished

object

id

required

Unique ID of the created item

string

$createdAt

required

Timestamp when the item was created

string format: date-time

fields

required

Field values keyed by field key

object

400

Invalid JSON body or field validation error

object

error

required

Machine-readable error code (mirrors code).

string

code

required

Machine-readable error code.

string

Allowed values: invalid_json validation_error posting_disabled model_posting_disabled origin_not_allowed not_found payload_too_large rate_limited access_denied unsupported_field_type

message

required

Human-readable description of the error.

string

details

Field-level validation errors, present only for validation_error.

Array<object>

object

field

string

code

string

message

string

403

Posting disabled for the project/model, or origin not allowed

object

error

required

Machine-readable error code (mirrors code).

string

code

required

Machine-readable error code.

string

Allowed values: invalid_json validation_error posting_disabled model_posting_disabled origin_not_allowed not_found payload_too_large rate_limited access_denied unsupported_field_type

message

required

Human-readable description of the error.

string

details

Field-level validation errors, present only for validation_error.

Array<object>

object

field

string

code

string

message

string

404

Model not found

object

error

required

Machine-readable error code (mirrors code).

string

code

required

Machine-readable error code.

string

Allowed values: invalid_json validation_error posting_disabled model_posting_disabled origin_not_allowed not_found payload_too_large rate_limited access_denied unsupported_field_type

message

required

Human-readable description of the error.

string

details

Field-level validation errors, present only for validation_error.

Array<object>

object

field

string

code

string

message

string

413

Request body exceeds the allowed size limit

object

error

required

Machine-readable error code (mirrors code).

string

code

required

Machine-readable error code.

string

Allowed values: invalid_json validation_error posting_disabled model_posting_disabled origin_not_allowed not_found payload_too_large rate_limited access_denied unsupported_field_type

message

required

Human-readable description of the error.

string

details

Field-level validation errors, present only for validation_error.

Array<object>

object

field

string

code

string

message

string

422

Model has a required field of an unsupported type for posting

object

error

required

Machine-readable error code (mirrors code).

string

code

required

Machine-readable error code.

string

Allowed values: invalid_json validation_error posting_disabled model_posting_disabled origin_not_allowed not_found payload_too_large rate_limited access_denied unsupported_field_type

message

required

Human-readable description of the error.

string

details

Field-level validation errors, present only for validation_error.

Array<object>

object

field

string

code

string

message

string

429

Too many requests; retry after the period indicated by the Retry-After header

object

error

required

Machine-readable error code (mirrors code).

string

code

required

Machine-readable error code.

string

Allowed values: invalid_json validation_error posting_disabled model_posting_disabled origin_not_allowed not_found payload_too_large rate_limited access_denied unsupported_field_type

message

required

Human-readable description of the error.

string

details

Field-level validation errors, present only for validation_error.

Array<object>

object

field

string

code

string

message

string

Headers

Retry-After

integer

Number of seconds to wait before retrying