Get the org's signup-time suggested namespace

Returns the namespace configuration that was suggested from Mixpeek’s company research at signup, if one was provisioned. Studio uses this to badge the suggested namespace.

GET /v1/onboarding/suggested-config

Get the org's signup-time suggested namespace

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/onboarding/suggested-config \
  --header 'Authorization: Bearer <token>'

200

{
  "exists": true,
  "namespace_name": "<string>",
  "rationale": "<string>",
  "manifest_applied": false,
  "applied_at": "2023-11-07T05:31:56Z",
  "sample_queries": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

Response

200

application/json

Successful Response

The org's signup-time suggested namespace, if one was provisioned.

Studio uses this to badge the suggested namespace with a "suggested from our research" indicator. exists is False when the signup was skipped (personal domain, no enrichment signal, feature disabled) or the org predates the feature; manifest_applied is False when a suggestion was generated but provisioning failed — show no indicator in either case.

exists · boolean · required

Whether a suggestion record exists for this org.

namespace_name · string | null

Name of the suggested (and provisioned) namespace.

rationale · string | null

One-sentence, user-facing reason this setup was suggested.

manifest_applied · boolean · default: false

True only if the suggested namespace was actually provisioned.

applied_at · string<date-time> | null

sample_queries · string[]