Invite a user

curl --request POST \
  --url https://api.mixpeek.com/v1/apps/{app_id}/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email_address": "<string>",
  "role": "org:member"
}
'

import requests

url = "https://api.mixpeek.com/v1/apps/{app_id}/users/invite"

payload = {
    "email_address": "<string>",
    "role": "org:member"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email_address: '<string>', role: 'org:member'})
};

fetch('https://api.mixpeek.com/v1/apps/{app_id}/users/invite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/apps/{app_id}/users/invite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email_address' => '<string>',
    'role' => 'org:member'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/apps/{app_id}/users/invite"

	payload := strings.NewReader("{\n  \"email_address\": \"<string>\",\n  \"role\": \"org:member\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/apps/{app_id}/users/invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email_address\": \"<string>\",\n  \"role\": \"org:member\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/apps/{app_id}/users/invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email_address\": \"<string>\",\n  \"role\": \"org:member\"\n}"

response = http.request(request)
puts response.read_body

{
  "invitation_id": "<string>",
  "email_address": "<string>",
  "role": "<string>",
  "status": "<string>",
  "created_at": "<string>"
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

POST

apps

{app_id}

users

invite

Invite a user

curl --request POST \
  --url https://api.mixpeek.com/v1/apps/{app_id}/users/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email_address": "<string>",
  "role": "org:member"
}
'

import requests

url = "https://api.mixpeek.com/v1/apps/{app_id}/users/invite"

payload = {
    "email_address": "<string>",
    "role": "org:member"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email_address: '<string>', role: 'org:member'})
};

fetch('https://api.mixpeek.com/v1/apps/{app_id}/users/invite', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/apps/{app_id}/users/invite",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email_address' => '<string>',
    'role' => 'org:member'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/apps/{app_id}/users/invite"

	payload := strings.NewReader("{\n  \"email_address\": \"<string>\",\n  \"role\": \"org:member\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/apps/{app_id}/users/invite")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email_address\": \"<string>\",\n  \"role\": \"org:member\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/apps/{app_id}/users/invite")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email_address\": \"<string>\",\n  \"role\": \"org:member\"\n}"

response = http.request(request)
puts response.read_body

{
  "invitation_id": "<string>",
  "email_address": "<string>",
  "role": "<string>",
  "status": "<string>",
  "created_at": "<string>"
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "error": {
    "details": {
      "id": "ns_123",
      "resource": "namespace"
    },
    "message": "Namespace not found",
    "type": "NotFoundError"
  },
  "status": 404,
  "success": false
}

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, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Path Parameters

app_id

string

required

App ID

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

email_address

string

required

Email address to invite

role

string

default:org:member

Clerk org role (org:admin or org:member)

Response

Successful Response

invitation_id

string

required

email_address

string

required

role

string

required

status

string

required

created_at

string | null

Namespaces

Buckets

Collections

Feature Extractors

Documents

Retrievers

Enrich & Improve

Automate

Administer

Advanced

Invite a user

Authorizations

Path Parameters

Body

Response