Allocate Concurrency to a Sub-workspace

PATCH

workspace

sub

{sub_workspace_id}

concurrency

Allocate Concurrency to a Sub-workspace

curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "concurrency": 20
}
'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency"

payload = { "concurrency": 20 }
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({concurrency: 20})
};

fetch('https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency', 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://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'concurrency' => 20
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <x-api-key>"
  ],
]);

$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://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency"

	payload := strings.NewReader("{\n  \"concurrency\": 20\n}")

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

	req.Header.Add("X-API-KEY", "<x-api-key>")
	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.patch("https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"concurrency\": 20\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"concurrency\": 20\n}"

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

{
  "message": "Mumbai Collections now has 20 concurrent calls",
  "sub_workspace_id": "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30",
  "concurrency": 20,
  "limit_concurrency": 20,
  "primary": {
    "id": "2f9a1c44-7e88-4bb1-9a01-5d3c2e7f6a11",
    "name": "Acme Collections HQ"
  },
  "family": {
    "parent_concurrency": 50,
    "allocated_total": 20
  }
}

{
  "detail": "Only 30 concurrent calls are available to allocate from the parent workspace (capacity 50, 20 already allocated to other sub-workspaces)."
}

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Invalid credentials"
  }
}

{
  "detail": "Sub-workspaces are not enabled for this workspace."
}

{
  "detail": "Sub-workspace not found"
}

{
  "error": {
    "code": "500 Internal Server Error",
    "message": "An unexpected error occurred on the server."
  }
}

Set how many concurrent calls one sub-workspace may run. Capacity is bought on the primary; the allocations across all sub-workspaces cannot exceed it.

When to use

Giving a newly created sub-workspace its first capacity (it starts at 0 and cannot call until allocated).
Rebalancing capacity between clients or teams.

Request parameters

Parameter	Type	Required	Description
`sub_workspace_id`	string (path)	Yes	ID of the sub-workspace.
`concurrency`	integer	Yes	Concurrent calls to allocate, `0` or more. `0` stops the sub-workspace from calling.

Integration notes

Authenticate with the primary workspace’s API key.
The value is absolute, not a delta. Lowering an allocation always succeeds; raising it must fit family.concurrency_available from Get Sub-workspaces.
limit_concurrency in the response is the persisted ceiling. In an individual-billing family it equals the allocation. In a common-billing family it is the family total, because idle capacity is shared, so it can be larger than concurrency.
This is the only allocation endpoint that applies to common-billing families; money is pooled on the primary there.

Error responses

400: Only 30 concurrent calls are available to allocate from the parent workspace (capacity 50, 20 already allocated to other sub-workspaces). — the allocation does not fit.
400: Sub-workspaces cannot have their own sub-workspaces. — the key belongs to a sub-workspace.
401: Invalid or missing API key.
403: Sub-workspaces are not enabled for this workspace.
404: Sub-workspace not found — no active sub-workspace with this id under your primary.
422: sub_workspace_id is not a UUID, or concurrency is negative or missing.

Example

curl --request PATCH "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30/concurrency" \
  --header "X-API-KEY: $RINGG_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{ "concurrency": 20 }'

Common follow-up

Buy more capacity on the primary when family.concurrency_available reaches 0, then allocate the new slots here.

Headers

X-API-KEY

string

required

(Required) The API key of the PRIMARY workspace. A sub-workspace's key is refused with 400.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Path Parameters

sub_workspace_id

string<uuid>

required

(Required) ID of the sub-workspace.

Example:

"b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30"

Body

application/json

concurrency

integer

required

(Required) Concurrent calls to allocate to this sub-workspace. 0 stops it from calling.

Required range: x >= 0

Example:

20

Response

Successful Response: The new allocation and the family totals.

message

string

Example:

"Mumbai Collections now has 20 concurrent calls"

sub_workspace_id

string

Example:

"b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30"

concurrency

integer

Example:

20

limit_concurrency

integer

The persisted ceiling: equals concurrency in an individual-billing family, the family total in a common-billing family.

Example:

20

primary

object

Show child attributes

family

object

Show child attributes

Allocate Concurrency to a Sub-workspace

curl --request PATCH \
  --url https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "concurrency": 20
}
'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency"

payload = { "concurrency": 20 }
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({concurrency: 20})
};

fetch('https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency', 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://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'concurrency' => 20
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <x-api-key>"
  ],
]);

$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://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency"

	payload := strings.NewReader("{\n  \"concurrency\": 20\n}")

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

	req.Header.Add("X-API-KEY", "<x-api-key>")
	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.patch("https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"concurrency\": 20\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/workspace/sub/{sub_workspace_id}/concurrency")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"concurrency\": 20\n}"

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

{
  "message": "Mumbai Collections now has 20 concurrent calls",
  "sub_workspace_id": "b7c1f0e2-4d3a-4a91-9f2e-8c1d5a6b7e30",
  "concurrency": 20,
  "limit_concurrency": 20,
  "primary": {
    "id": "2f9a1c44-7e88-4bb1-9a01-5d3c2e7f6a11",
    "name": "Acme Collections HQ"
  },
  "family": {
    "parent_concurrency": 50,
    "allocated_total": 20
  }
}

{
  "detail": "Only 30 concurrent calls are available to allocate from the parent workspace (capacity 50, 20 already allocated to other sub-workspaces)."
}

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Invalid credentials"
  }
}

{
  "detail": "Sub-workspaces are not enabled for this workspace."
}

{
  "detail": "Sub-workspace not found"
}

{
  "error": {
    "code": "500 Internal Server Error",
    "message": "An unexpected error occurred on the server."
  }
}

Get Started

API Reference

Webhooks Setup

Telephony Integration

MCP Server

External Integrations

Privacy and Compliance

Allocate Concurrency to a Sub-workspace

When to use

Request parameters

Integration notes

Error responses

Example

Common follow-up

Headers

Path Parameters

Body

Response

​When to use

​Request parameters

​Integration notes

​Error responses

​Example

​Common follow-up

Headers

Path Parameters

Body

Response

When to use

Request parameters

Integration notes

Error responses

Example

Common follow-up