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. Mappings belong to a workspace, so pass workspace_id on reads and writes. Reads need mapping:read and writes need mapping:write.

List mappings

Get a mapping

Create a mapping

string
required
The workspace the mapping belongs to.
string
required
The incoming name callers send.
string
required
The gateway name to route to.
integer
The order in which mappings are matched. Lower runs first.
boolean
Whether the mapping is active.
boolean
Treat source_name as a pattern rather than an exact match.

Update a mapping

Accepts any create field. Send workspace_id in the body.

Delete a mapping