Published Retrievers

Check Name Availability

Changed on

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.

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

Path parameters

retriever_idstring required

ID of the retriever

Query parameters

namestring required

Public name to check

Response

Successful Response

namestring required

The public name that was checked

availableboolean required

Whether the name is available for use

Changes

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API