Check Name Availability

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish/availability \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "available": true
}

GET

retrievers

{retriever_id}

publish

availability

Check Name Availability

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/publish/availability \
  --header 'Authorization: Bearer <token>'

{
  "name": "<string>",
  "available": true
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

retriever_id

string

required

ID of the retriever

name

string

required

Public name to check

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