---
title: "Check Name Availability"
method: GET
path: "/v1/retrievers/{retriever_id}/publish/availability"
tags: ["Published Retrievers"]
---

# Check Name Availability

`GET /v1/retrievers/{retriever_id}/publish/availability`

## Request

- Base URL: `https://api.mixpeek.com`
- URL: `https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish/availability`
- Auth: HTTP bearer and API key in header `X-Namespace`

Check if a public name is available.

Public names must be globally unique across all organizations.
Use this endpoint before publishing to ensure your desired name is available.

## Path parameters

- `retriever_id` string, required: ID of the retriever

## Query parameters

- `name` string, required: Public name to check

## Response `200`

Successful Response

- PublicNameAvailabilityResponse: Response for public name availability check.
  - `name` string, required: The public name that was checked
  - `available` boolean, required: Whether the name is available for use

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-10-09** `61a175e8eb9a`: 1 warning, 5 info
  - removed the optional property `detail` from the response with the `422` status
  - added the non-success response with the status `429`
  - added the non-success response with the status `503`
  - added the optional property `success` to the response with the `422` status
  - …2 more
- **2026-08-09** `5d4c905106b4`: 1 info
  - the endpoint scheme security `BearerAuth AND NamespaceHeader` was added to the API

[Operation history](https://skmtc.dev/mixpeek/apis/mixpeek-api/changes/v1/retrievers/:retriever_id/publish/availability/get.md)

---

[API](https://skmtc.dev/mixpeek/apis/mixpeek-api.md) - [All operations](https://skmtc.dev/mixpeek/apis/mixpeek-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mixpeek/apis/mixpeek-api/revisions/790bc16455f6?raw)