Skip to main content

Get Embedding Config

GET 
/embedding-configs/:config_ref

Return a single embedding config by id, or by name within one workspace.

config_ref is tried first as a config id; if no live (non-deleted) config matches, it is tried as a name. A reference that resolves to a config outside the caller's workspaces is reported as not found rather than forbidden, so the response does not confirm the config's existence to a caller who cannot see it.

Names are unique only within a workspace, so workspace_id says which one to resolve a name in — needed whenever the same name exists in several, as the reserved opt-out name does in every workspace. Without it, a name matching in more than one workspace the caller can see is rejected as ambiguous rather than resolved arbitrarily. It is ignored when config_ref is an id, since ids are already unique.

Request​

Responses​

Successful Response