Create an invite

⚠️

Preview — this feature is being built; the design below is the spec.

POST https://app.syntic.ai/v1/organizations/invites

Invite one person by email, with an organization role and optionally workspace memberships that apply when they accept. Inviting an address that already has a pending invite returns that invite with 200 OK and sends no second email.

For how this fits into a full workflow, see Invites.

Headers

Header	Required	Value
`Authorization`	Yes	`Bearer <admin key>`: an Admin API key (`sk_admin_...`). Inference keys are refused with `403 admin_key_required`. See Admin API keys.
`syntic-beta`	Yes, while in preview	`admin-2026-11-01`. Without it the call fails with `400 beta_required`. See Versioning.
`Content-Type`	Yes	`application/json`
`Idempotency-Key`	No	Up to 255 characters. Retrying with the same key within 24 hours returns the first result instead of creating a duplicate. See Idempotency.

Body parameters

Parameter	Type	Required	Notes
`email`	string	Yes	One address.
`role`	string	No	`developer` (default) or `administrator`. Owners are never invited.
`workspaces`	array	No	Up to 20 `{workspace_id, role}` entries.

Response

201 Created, Content-Type: application/json

{
  "id": "invite_01JCD3F5H7K9M1P3R5T7",
  "type": "invite",
  "email": "sam@example.com",
  "role": "developer",
  "workspaces": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "role": "workspace_developer"
    }
  ],
  "status": "pending",
  "invited_by": {
    "id": "user_01J9X8Z6B4D2F0H8K6M4",
    "email": "ops@example.com"
  },
  "created_at": "2026-11-05T10:00:00Z",
  "expires_at": "2026-11-12T10:00:00Z",
  "accepted_at": null
}

Examples

curl -sS https://app.syntic.ai/v1/organizations/invites \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: admin-2026-11-01" \
  -H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
  -H "Content-Type: application/json" \
  -d '{
      "email": "sam@example.com",
      "role": "developer",
      "workspaces": [
        {
          "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
          "role": "workspace_developer"
        }
      ]
    }'

import os
 
import requests
 
resp = requests.post(
    "https://app.syntic.ai/v1/organizations/invites",
    headers={
        "Authorization": f"Bearer {os.environ['SYNTIC_ADMIN_KEY']}",
        "syntic-beta": "admin-2026-11-01",
        "Idempotency-Key": "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69",
    },
    json={
        "email": "sam@example.com",
        "role": "developer",
        "workspaces": [
            {
                "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
                "role": "workspace_developer",
            },
        ],
    },
    timeout=60,
)
data = resp.json()
if not resp.ok:
    raise RuntimeError(f"{resp.status_code} {data['error']['code']}: {data['error']['message']}")
print(data)

const res = await fetch('https://app.syntic.ai/v1/organizations/invites', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNTIC_ADMIN_KEY}`,
    'syntic-beta': 'admin-2026-11-01',
    'Idempotency-Key': '8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "email": "sam@example.com",
    "role": "developer",
    "workspaces": [
      {
        "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
        "role": "workspace_developer"
      }
    ]
  }),
})
const data = await res.json()
if (!res.ok) throw new Error(`${res.status} ${data.error.code}: ${data.error.message}`)
console.log(data)

package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)
 
func main() {
	body := strings.NewReader(`{
  "email": "sam@example.com",
  "role": "developer",
  "workspaces": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "role": "workspace_developer"
    }
  ]
}`)
	req, err := http.NewRequest("POST", "https://app.syntic.ai/v1/organizations/invites", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTIC_ADMIN_KEY"))
	req.Header.Set("syntic-beta", "admin-2026-11-01")
	req.Header.Set("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69")
	req.Header.Set("Content-Type", "application/json")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, _ := io.ReadAll(resp.Body)
	if resp.StatusCode >= 300 {
		panic(fmt.Sprintf("%d: %s", resp.StatusCode, out))
	}
	fmt.Println(string(out))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "email": "sam@example.com",
              "role": "developer",
              "workspaces": [
                {
                  "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
                  "role": "workspace_developer"
                }
              ]
            }
            """;
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://app.syntic.ai/v1/organizations/invites"))
            .header("Authorization", "Bearer " + System.getenv("SYNTIC_ADMIN_KEY"))
            .header("syntic-beta", "admin-2026-11-01")
            .header("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 300) {
            throw new RuntimeException(response.statusCode() + ": " + response.body());
        }
        System.out.println(response.body());
    }
}

using System.Net.Http.Headers;
using System.Text;
 
using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://app.syntic.ai/v1/organizations/invites");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("SYNTIC_ADMIN_KEY"));
request.Headers.Add("syntic-beta", "admin-2026-11-01");
request.Headers.Add("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69");
request.Content = new StringContent("""
    {
      "email": "sam@example.com",
      "role": "developer",
      "workspaces": [
        {
          "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
          "role": "workspace_developer"
        }
      ]
    }
    """, Encoding.UTF8, "application/json");
 
using var response = await http.SendAsync(request);
var text = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode) throw new Exception($"{(int)response.StatusCode}: {text}");
Console.WriteLine(text);

<?php
$body = <<<'JSON'
{
  "email": "sam@example.com",
  "role": "developer",
  "workspaces": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "role": "workspace_developer"
    }
  ]
}
JSON;
 
$ch = curl_init('https://app.syntic.ai/v1/organizations/invites');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SYNTIC_ADMIN_KEY'),
        'syntic-beta: admin-2026-11-01',
        'Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
 
if ($status >= 300) {
    throw new RuntimeException("$status: $response");
}
print_r(json_decode($response, true));

require "json"
require "net/http"
require "uri"
 
uri = URI("https://app.syntic.ai/v1/organizations/invites")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch('SYNTIC_ADMIN_KEY')}"
req["syntic-beta"] = "admin-2026-11-01"
req["Idempotency-Key"] = "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69"
req["Content-Type"] = "application/json"
req.body = <<~'JSON'
  {
    "email": "sam@example.com",
    "role": "developer",
    "workspaces": [
      {
        "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
        "role": "workspace_developer"
      }
    ]
  }
JSON
 
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
raise "#{res.code}: #{res.body}" unless res.is_a?(Net::HTTPSuccess)
puts JSON.pretty_generate(JSON.parse(res.body))

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

Status	`type`	`code`	When
400	`invalid_request_error`	`beta_required`	The `syntic-beta` header is missing.
400	`invalid_request_error`	`invalid_email`	Not a valid address.
400	`invalid_request_error`	`invalid_role`	Not `administrator` or `developer`.
403	`permission_error`	`role_required`	The admin key’s creator does not have the role this needs.
403	`permission_error`	`email_domain_not_allowed`	The organization limits members to certain email domains.
409	`conflict_error`	`already_member`	The address belongs to an active member.
409	`conflict_error`	`seat_limit_reached`	The plan has no free seats.
401	`authentication_error`	`invalid_api_key`	The admin key is missing, unknown, revoked or expired.
403	`permission_error`	`admin_key_required`	An inference key was used.
429	`rate_limit_error`	`rate_limited`	Too many requests; wait for `Retry-After`. See Rate-limit headers.

Invites List invites

Was this page helpful?