Create model provider config

curl --request POST \
  --url https://api.omnara.com/v1/orgs/{orgID}/model-provider-configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "credential_secret_id": "<string>",
  "base_url": "<string>",
  "endpoint_path": "<string>",
  "request_timeout_ms": 1073741824,
  "auth_options": {
    "header_name": "<string>"
  }
}
'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/model-provider-configs"

payload = {
    "name": "<string>",
    "credential_secret_id": "<string>",
    "base_url": "<string>",
    "endpoint_path": "<string>",
    "request_timeout_ms": 1073741824,
    "auth_options": { "header_name": "<string>" }
}
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({
    name: '<string>',
    credential_secret_id: '<string>',
    base_url: '<string>',
    endpoint_path: '<string>',
    request_timeout_ms: 1073741824,
    auth_options: {header_name: '<string>'}
  })
};

fetch('https://api.omnara.com/v1/orgs/{orgID}/model-provider-configs', 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.omnara.com/v1/orgs/{orgID}/model-provider-configs",
  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([
    'name' => '<string>',
    'credential_secret_id' => '<string>',
    'base_url' => '<string>',
    'endpoint_path' => '<string>',
    'request_timeout_ms' => 1073741824,
    'auth_options' => [
        'header_name' => '<string>'
    ]
  ]),
  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.omnara.com/v1/orgs/{orgID}/model-provider-configs"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"credential_secret_id\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"endpoint_path\": \"<string>\",\n  \"request_timeout_ms\": 1073741824,\n  \"auth_options\": {\n    \"header_name\": \"<string>\"\n  }\n}")

	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://api.omnara.com/v1/orgs/{orgID}/model-provider-configs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"credential_secret_id\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"endpoint_path\": \"<string>\",\n  \"request_timeout_ms\": 1073741824,\n  \"auth_options\": {\n    \"header_name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omnara.com/v1/orgs/{orgID}/model-provider-configs")

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 = "{\n  \"name\": \"<string>\",\n  \"credential_secret_id\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"endpoint_path\": \"<string>\",\n  \"request_timeout_ms\": 1073741824,\n  \"auth_options\": {\n    \"header_name\": \"<string>\"\n  }\n}"

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

{
  "config": {
    "id": "<string>",
    "org_id": "<string>",
    "management_kind": "tenant",
    "name": "<string>",
    "api_format": "openai-responses",
    "api_variant": "<string>",
    "base_url": "<string>",
    "endpoint_path": "<string>",
    "request_timeout_ms": 123,
    "auth_kind": "bearer_token",
    "auth_options": {
      "header_name": "<string>"
    },
    "credential_secret_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "model_catalog": {
    "status": "ok",
    "models": [
      {
        "slug": "<string>",
        "display_name": "<string>",
        "context_window_tokens": 1073741824,
        "max_output_tokens": 1073741824
      }
    ],
    "error": "<string>"
  }
}

{
  "config": {
    "id": "<string>",
    "org_id": "<string>",
    "management_kind": "tenant",
    "name": "<string>",
    "api_format": "openai-responses",
    "api_variant": "<string>",
    "base_url": "<string>",
    "endpoint_path": "<string>",
    "request_timeout_ms": 123,
    "auth_kind": "bearer_token",
    "auth_options": {
      "header_name": "<string>"
    },
    "credential_secret_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "model_catalog": {
    "status": "ok",
    "models": [
      {
        "slug": "<string>",
        "display_name": "<string>",
        "context_window_tokens": 1073741824,
        "max_output_tokens": 1073741824
      }
    ],
    "error": "<string>"
  }
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "internal_error"
}

POST

orgs

{orgID}

model-provider-configs

Create model provider config

curl --request POST \
  --url https://api.omnara.com/v1/orgs/{orgID}/model-provider-configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "credential_secret_id": "<string>",
  "base_url": "<string>",
  "endpoint_path": "<string>",
  "request_timeout_ms": 1073741824,
  "auth_options": {
    "header_name": "<string>"
  }
}
'

import requests

url = "https://api.omnara.com/v1/orgs/{orgID}/model-provider-configs"

payload = {
    "name": "<string>",
    "credential_secret_id": "<string>",
    "base_url": "<string>",
    "endpoint_path": "<string>",
    "request_timeout_ms": 1073741824,
    "auth_options": { "header_name": "<string>" }
}
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({
    name: '<string>',
    credential_secret_id: '<string>',
    base_url: '<string>',
    endpoint_path: '<string>',
    request_timeout_ms: 1073741824,
    auth_options: {header_name: '<string>'}
  })
};

fetch('https://api.omnara.com/v1/orgs/{orgID}/model-provider-configs', 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.omnara.com/v1/orgs/{orgID}/model-provider-configs",
  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([
    'name' => '<string>',
    'credential_secret_id' => '<string>',
    'base_url' => '<string>',
    'endpoint_path' => '<string>',
    'request_timeout_ms' => 1073741824,
    'auth_options' => [
        'header_name' => '<string>'
    ]
  ]),
  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.omnara.com/v1/orgs/{orgID}/model-provider-configs"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"credential_secret_id\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"endpoint_path\": \"<string>\",\n  \"request_timeout_ms\": 1073741824,\n  \"auth_options\": {\n    \"header_name\": \"<string>\"\n  }\n}")

	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://api.omnara.com/v1/orgs/{orgID}/model-provider-configs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"credential_secret_id\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"endpoint_path\": \"<string>\",\n  \"request_timeout_ms\": 1073741824,\n  \"auth_options\": {\n    \"header_name\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omnara.com/v1/orgs/{orgID}/model-provider-configs")

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 = "{\n  \"name\": \"<string>\",\n  \"credential_secret_id\": \"<string>\",\n  \"base_url\": \"<string>\",\n  \"endpoint_path\": \"<string>\",\n  \"request_timeout_ms\": 1073741824,\n  \"auth_options\": {\n    \"header_name\": \"<string>\"\n  }\n}"

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

{
  "config": {
    "id": "<string>",
    "org_id": "<string>",
    "management_kind": "tenant",
    "name": "<string>",
    "api_format": "openai-responses",
    "api_variant": "<string>",
    "base_url": "<string>",
    "endpoint_path": "<string>",
    "request_timeout_ms": 123,
    "auth_kind": "bearer_token",
    "auth_options": {
      "header_name": "<string>"
    },
    "credential_secret_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "model_catalog": {
    "status": "ok",
    "models": [
      {
        "slug": "<string>",
        "display_name": "<string>",
        "context_window_tokens": 1073741824,
        "max_output_tokens": 1073741824
      }
    ],
    "error": "<string>"
  }
}

{
  "config": {
    "id": "<string>",
    "org_id": "<string>",
    "management_kind": "tenant",
    "name": "<string>",
    "api_format": "openai-responses",
    "api_variant": "<string>",
    "base_url": "<string>",
    "endpoint_path": "<string>",
    "request_timeout_ms": 123,
    "auth_kind": "bearer_token",
    "auth_options": {
      "header_name": "<string>"
    },
    "credential_secret_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "model_catalog": {
    "status": "ok",
    "models": [
      {
        "slug": "<string>",
        "display_name": "<string>",
        "context_window_tokens": 1073741824,
        "max_output_tokens": 1073741824
      }
    ],
    "error": "<string>"
  }
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "invalid_request"
}

{
  "error": "<string>",
  "code": "internal_error"
}

Authorizations

Authorization

string

header

required

An opaque Omnara personal or organization bearer token.

Path Parameters

orgID

string

required

Pattern: ^org_[a-z2-7]{26}$

Body

application/json

Connect Omnara to a model API endpoint. Use a preset for built-in providers, or provide api_format and base_url for a custom endpoint. When omitted, endpoint_path and auth settings are filled from api_format.

name

string

required

Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.

Required string length: 1 - 64

credential_secret_id

string

required

Pattern: ^sec_[a-z2-7]{26}$

preset

enum<string>

Available options:

openai,

openrouter,

anthropic

api_format

enum<string>

Available options:

openai-responses,

openai-chat-completions,

anthropic-messages

api_variant

enum<string>

Available options:

default,

openrouter,

bedrock

base_url

string

Provider endpoint base URL. Normal API mode requires a public HTTPS endpoint; localhost and loopback endpoints are accepted only when the API is running in insecure dev mode.

Minimum string length: 1

endpoint_path

string

URL path under base_url. Defaults to /responses for OpenAI Responses, /chat/completions for Chat Completions, and /messages for Anthropic Messages.

Minimum string length: 1

Pattern: ^/

request_timeout_ms

integer

Provider request timeout in milliseconds. Omitted value defaults to 600000.

Required range: 1 <= x <= 2147483647

auth_kind

enum<string>

Available options:

bearer_token,

api_key_header

auth_options

object

Non-secret API-key placement settings. Use an empty object with bearer_token. With api_key_header, set {"header_name":"..."}; Anthropic Messages defaults to {"header_name":"x-api-key"}.

Show child attributes

Response

Route response.

config

object

required

Show child attributes

model_catalog

object

required

The provider's model catalog, obtained by validating the configured credential and probing the provider's /models endpoint. A failed probe does not affect the stored config; treat it as a warning that the base URL or API key may be invalid.

Show child attributes

API reference

Endpoints

Create model provider config

Authorizations

Path Parameters

Body

Response