Create or replace a provisioning document

Create or replace a provisioning document (POST = replace)

curl --request POST \
  --url https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}"

payload = {}
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({})
};

fetch('https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}', 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://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}",
  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([
    
  ]),
  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://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}"

	payload := strings.NewReader("{}")

	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://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}")

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 = "{}"

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

{}

{}

{
  "code": "BadRequest",
  "message": "Invalid request parameters"
}

{
  "code": "Unauthenticated",
  "message": "Authorization header with Bearer token is required"
}

{
  "code": "PermissionDenied",
  "message": "API key does not allow this operation"
}

POST

api

provisioning

tenants

{tenantId}

{collection}

{docId}

Create or replace a provisioning document (POST = replace)

curl --request POST \
  --url https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}"

payload = {}
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({})
};

fetch('https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}', 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://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}",
  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([
    
  ]),
  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://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}"

	payload := strings.NewReader("{}")

	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://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.crescendo.ai/api/v1/provisioning/tenants/{tenantId}/{collection}/{docId}")

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 = "{}"

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

{}

{}

{
  "code": "BadRequest",
  "message": "Invalid request parameters"
}

{
  "code": "Unauthenticated",
  "message": "Authorization header with Bearer token is required"
}

{
  "code": "PermissionDenied",
  "message": "API key does not allow this operation"
}

POST requests replace the document at the target path:

If the document does not exist, the API returns 201 Created
If the document exists, the API returns 200 OK and the previous document content is replaced

The API stamps updated (epoch millis) and updatedBy automatically.

Example: create a user

export CRESCENDO_TENANT_ID="tenant-alpha"
export CRESCENDO_API_KEY="YOUR_API_KEY"

curl -sS -X POST \
  -H "Authorization: Bearer $CRESCENDO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"new.user@example.com","role":"viewer"}' \
  "https://platform.crescendo.ai/api/v1/provisioning/tenants/$CRESCENDO_TENANT_ID/users/user-123"

Example: write a versioned resource

For versioned resources, you can include versions.current in the payload:

curl -sS -X POST \
  -H "Authorization: Bearer $CRESCENDO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Support Bot","versions":{"current":{"spec":{"greeting":"hello"}}}}' \
  "https://platform.crescendo.ai/api/v1/provisioning/tenants/$CRESCENDO_TENANT_ID/bots/bot-002"

Authorizations

Authorization

string

header

required

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

Path Parameters

tenantId

string

required

Tenant identifier.

collection

string

required

Collection name under the tenant (for example: users, bots, jobs).

docId

string

required

Document identifier within the collection.

Body

application/json

Arbitrary JSON object representing the provisioning resource.

Response

Replaced (existing document)

Arbitrary JSON object representing the provisioning resource.

⌘I

Overview

Provisioning

Reporting

VOC

MCP

Create or replace a provisioning document

Example: create a user

Example: write a versioned resource

Authorizations

Path Parameters

Body

Response

​Example: create a user

​Example: write a versioned resource

Authorizations

Path Parameters

Body

Response

Example: create a user

Example: write a versioned resource