Set user credits limits

Set individual per-user credits limits for one or more users. Supports bulk updates (up to 100 users per request). Identify each user by email. Pass null for limit to remove an individual override.

PUT /api/v0/organization/usage/limits/users

Set user credits limits

cURL

curl --request PUT \
  --url https://api.factory.ai/api/v0/organization/usage/limits/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "email": "[e-mail]",
      "limit": 1000001
    }
  ]
}
'

import requests

url = "https://api.factory.ai/api/v0/organization/usage/limits/users"

payload = { "users": [
        {
            "email": "[e-mail]",
            "limit": 1000001
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({users: [{email: '[e-mail]', limit: 1000001}]})
};

fetch('https://api.factory.ai/api/v0/organization/usage/limits/users', 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.factory.ai/api/v0/organization/usage/limits/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'users' => [
        [
                'email' => '[e-mail]',
                'limit' => 1000001
        ]
    ]
  ]),
  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.factory.ai/api/v0/organization/usage/limits/users"

	payload := strings.NewReader("{\n  \"users\": [\n    {\n      \"email\": \"[e-mail]\",\n      \"limit\": 1000001\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.factory.ai/api/v0/organization/usage/limits/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"users\": [\n    {\n      \"email\": \"[e-mail]\",\n      \"limit\": 1000001\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.factory.ai/api/v0/organization/usage/limits/users")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"users\": [\n    {\n      \"email\": \"[e-mail]\",\n      \"limit\": 1000001\n    }\n  ]\n}"

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

200

{
  "updated": [
    {
      "email": "[e-mail]",
      "limit": 1
    }
  ],
  "errors": [
    {
      "email": "<string>",
      "error": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

Factory API key or JWT token for authentication

Body

application/json

users · object[] · required

Array of user limit entries (up to 100). Each identifies a user by email.

Required array length: 1 - 100 elements

Show child attributes

Response

200

application/json

Response for status 200

updated · object[] · required

Successfully updated user limits

Show child attributes

errors · object[] · required

Errors for users that could not be updated

Show child attributes