Skip to main content
A mapping points an incoming model name at a target model, so callers can use a stable name while you change what runs behind it. Reads are scoped by workspace_id. Reads need mapping:read and writes need mapping:write.

List mappings

string
Limit results to one workspace.
string
Match mappings whose source name contains this value.
string
Match mappings whose target model contains this value.

Get a mapping

Create a mapping

Creates land in your account’s default workspace. A workspace_id in the body is ignored.
string
required
The incoming name callers send.
string
required
The gateway name to route to.
integer
default:"0"
0 to 1000. The order in which mappings are matched. Lower runs first.
boolean
default:"true"
Whether the mapping is active.
boolean
default:"true"
Treat source_name as a pattern rather than an exact match. This defaults to true, so a mapping is a pattern unless you say otherwise.

Update a mapping

PATCH is a full replace, not a merge. It validates the same schema as create, so source_name and target_model are required on every update.
The response carries no body beyond { "success": true }. The SDK re-reads the mapping after a write.

Delete a mapping