Skip to main content
GET
/
v1
/
retrievers
/
{retriever_id}
/
publish
/
availability
Check Name Availability
curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish/availability
{
  "name": "<string>",
  "available": true
}

Headers

​
Authorization
string

Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Example:

"Bearer YOUR_MIXPEEK_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
retriever_id
string
required

ID of the retriever

Query Parameters

​
name
string
required

Public name to check

Response

Successful Response

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