Skip to main content
POST
Create model provider config

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

Total deadline for one provider attempt, including reasoning and response streaming, in milliseconds. Defaults to 3600000 (60 minutes). Retries have separate deadlines.

Required range: 1 <= x <= 2147483647
idle_timeout_ms
integer

Maximum wait for response headers or the next response bytes, in milliseconds. Heartbeats count as activity. Defaults to 300000 (5 minutes). Local response processing does not consume this idle budget.

Required range: 1 <= x <= 2147483647
auth_kind
enum<string>
Available options:
bearer_token,
api_key_header,
sigv4
auth_options
object

Non-secret authentication settings. Use an empty object with bearer_token. With api_key_header, set {"header_name":"..."}; Anthropic Messages defaults to {"header_name":"x-api-key"}. With sigv4, set the AWS signing service and region.

headers
object

Extra HTTP headers sent with every request to this provider. Values are stored and returned as plain text; use secret_headers for keys and tokens.

secret_headers
object

Extra HTTP headers whose values come from org-owned generic secrets, mapping header names to secret references.

Response

Created route response.

config
object
required
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.