Register an OAuth app

⚠️

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

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

Register your own application so people can sign in with their Syntic account and use Syntic models under their own plan, with the same authorization-code flow that Syntic’s apps use. Confidential apps receive a client secret, shown only in this response.

For how this fits into a full workflow, see Build a Sign in with Syntic app.

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	`oauth-apps-2026-12-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 acting twice. See Idempotency.

Body parameters

Parameter	Type	Required	Notes
`name`	string	Yes	Shown on the approval screen. 3 to 64 characters.
`client_type`	string	Yes
`redirect_uris`	array of strings	Yes	1 to 10.
`allowed_scopes`	array of strings	Yes
`audience`	string	No	Default `organization`.
`logo_url`	string	No	HTTPS, square PNG or SVG.

Response

201 Created, Content-Type: application/json

{
  "id": "oapp_01JD79H1K3M5P7R9T1V3",
  "type": "oauth_app",
  "client_id": "oapp_01JD79H1K3M5P7R9T1V3",
  "name": "Acme Notes",
  "client_type": "confidential",
  "redirect_uris": [
    "https://notes.example.com/oauth/callback"
  ],
  "allowed_scopes": [
    "user:profile",
    "user:inference"
  ],
  "audience": "organization",
  "logo_url": "https://notes.example.com/logo.png",
  "status": "active",
  "created_at": "2026-11-05T10:00:00Z",
  "client_secret": "scs_live_Hn2…redacted"
}

Field	Type	Description
`client_type`	string	`public` (no secret; PKCE required) for desktop, mobile and browser apps, or `confidential` (has a secret; PKCE still required) for server-side apps.
`redirect_uris`	array	Exact HTTPS addresses. Loopback `http://127.0.0.1` with any port is allowed for public desktop clients.
`allowed_scopes`	array	The most the app can ask for. `user:inference` lets it call `/v1` billed to the signing-in person’s organization.
`audience`	string	`organization`: only your members can sign in. `any`: any Syntic user can, after Syntic reviews the app.
`client_secret`	string	Confidential apps only; returned once.

Examples

curl -sS "https://app.syntic.ai/v1/organizations/oauth_apps" \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: oauth-apps-2026-12-01" \
  -H "Idempotency-Key: 8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69" \
  -H "Content-Type: application/json" \
  -d '{
      "name": "Acme Notes",
      "client_type": "confidential",
      "redirect_uris": [
        "https://notes.example.com/oauth/callback"
      ],
      "allowed_scopes": [
        "user:profile",
        "user:inference"
      ]
    }'

import os
 
import requests
 
resp = requests.post(
    "https://app.syntic.ai/v1/organizations/oauth_apps",
    headers={
        "Authorization": f"Bearer {os.environ['SYNTIC_ADMIN_KEY']}",
        "syntic-beta": "oauth-apps-2026-12-01",
        "Idempotency-Key": "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69",
    },
    json={
        "name": "Acme Notes",
        "client_type": "confidential",
        "redirect_uris": [
            "https://notes.example.com/oauth/callback"
        ],
        "allowed_scopes": [
            "user:profile",
            "user:inference"
        ]
    },
    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/oauth_apps', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNTIC_ADMIN_KEY}`,
    'syntic-beta': 'oauth-apps-2026-12-01',
    'Idempotency-Key': '8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Acme Notes",
    "client_type": "confidential",
    "redirect_uris": [
      "https://notes.example.com/oauth/callback"
    ],
    "allowed_scopes": [
      "user:profile",
      "user:inference"
    ]
  }),
})
const text = await res.text()
const data = text ? JSON.parse(text) : null
if (!res.ok) throw new Error(`${res.status} ${data.error.code}: ${data.error.message}`)
console.log(data ?? res.status)

package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)
 
func main() {
	body := strings.NewReader(`{
  "name": "Acme Notes",
  "client_type": "confidential",
  "redirect_uris": [
    "https://notes.example.com/oauth/callback"
  ],
  "allowed_scopes": [
    "user:profile",
    "user:inference"
  ]
}`)
	req, err := http.NewRequest("POST", "https://app.syntic.ai/v1/organizations/oauth_apps", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTIC_ADMIN_KEY"))
	req.Header.Set("syntic-beta", "oauth-apps-2026-12-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 = """
            {
              "name": "Acme Notes",
              "client_type": "confidential",
              "redirect_uris": [
                "https://notes.example.com/oauth/callback"
              ],
              "allowed_scopes": [
                "user:profile",
                "user:inference"
              ]
            }
            """;
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://app.syntic.ai/v1/organizations/oauth_apps"))
            .header("Authorization", "Bearer " + System.getenv("SYNTIC_ADMIN_KEY"))
            .header("syntic-beta", "oauth-apps-2026-12-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/oauth_apps");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("SYNTIC_ADMIN_KEY"));
request.Headers.Add("syntic-beta", "oauth-apps-2026-12-01");
request.Headers.Add("Idempotency-Key", "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69");
request.Content = new StringContent("""
    {
      "name": "Acme Notes",
      "client_type": "confidential",
      "redirect_uris": [
        "https://notes.example.com/oauth/callback"
      ],
      "allowed_scopes": [
        "user:profile",
        "user:inference"
      ]
    }
    """, 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'
{
  "name": "Acme Notes",
  "client_type": "confidential",
  "redirect_uris": [
    "https://notes.example.com/oauth/callback"
  ],
  "allowed_scopes": [
    "user:profile",
    "user:inference"
  ]
}
JSON;
 
$ch = curl_init('https://app.syntic.ai/v1/organizations/oauth_apps');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SYNTIC_ADMIN_KEY'),
        'syntic-beta: oauth-apps-2026-12-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) ?? $status);

require "json"
require "net/http"
require "uri"
 
uri = URI("https://app.syntic.ai/v1/organizations/oauth_apps")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch('SYNTIC_ADMIN_KEY')}"
req["syntic-beta"] = "oauth-apps-2026-12-01"
req["Idempotency-Key"] = "8d6f0c1e-4b2a-4a57-9f0e-2f1d3c4b5a69"
req["Content-Type"] = "application/json"
req.body = <<~'JSON'
  {
    "name": "Acme Notes",
    "client_type": "confidential",
    "redirect_uris": [
      "https://notes.example.com/oauth/callback"
    ],
    "allowed_scopes": [
      "user:profile",
      "user:inference"
    ]
  }
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 res.body.empty? ? res.code : 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_redirect_uri`	Not HTTPS (other than loopback), contains a fragment, or uses a wildcard.
400	`invalid_request_error`	`scope_not_allowed`	A scope apps may not hold, such as any that creates API keys.
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.

Introspect a token List apps

Was this page helpful?