Sign in
Workspace LLM

Connect your own AI provider

Changed on
post/workspaces/{workspaceSlug}/llm/connections

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/llm/connections
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Request body

apiKeystring

API key (write-only; never returned)

apiProtocolstring required

Wire protocol

authMode'BEARER' | 'API_KEY'

Credential shape (default BEARER)

baseUrlstring required

Provider base URL

connectionPlatform'LOGOS' | 'VLLM' | 'OLLAMA' | 'AZURE' | 'AWS_BEDROCK' | 'GOOGLE_VERTEX' | 'OPENAI' | 'GOOGLE_AI_STUDIO' | 'ALIBABA_CLOUD' | 'GROQ' | 'FIREWORKS' | 'TOGETHER_AI' | 'DEEPINFRA' | 'NEBIUS' | 'OPENROUTER' | 'CLOUDFLARE_AI_GATEWAY' | 'VERCEL_AI_GATEWAY'

Admin-declared connection platform; null when not declared

displayNamestring required

Human-readable name

enabledboolean

Whether the connection is active (default false)

slugstring

Optional internal slug; generated from displayName when omitted

Example request

{
  "apiProtocol": "openai-responses"
}

Response

Connection created; URL in the Location header

apiKeyLast4string

Last four characters of the stored API key, if any

apiProtocolstring required

Wire protocol

authMode'BEARER' | 'API_KEY' required

Credential shape

baseUrlstring required

Provider base URL

connectionPlatform'LOGOS' | 'VLLM' | 'OLLAMA' | 'AZURE' | 'AWS_BEDROCK' | 'GOOGLE_VERTEX' | 'OPENAI' | 'GOOGLE_AI_STUDIO' | 'ALIBABA_CLOUD' | 'GROQ' | 'FIREWORKS' | 'TOGETHER_AI' | 'DEEPINFRA' | 'NEBIUS' | 'OPENROUTER' | 'CLOUDFLARE_AI_GATEWAY' | 'VERCEL_AI_GATEWAY'

Admin-declared connection platform

createdAtstring date-time required

Creation timestamp

displayNamestring required

Human-readable name

enabledboolean required

Whether the connection is active

hasApiKeyboolean required

Whether an API key is stored

idinteger required

Connection ID

slugstring required

Unique slug within the workspace

updatedAtstring date-time

Last update timestamp

Example response

{
  "apiProtocol": "openai-responses",
  "slug": "openai-prod"
}

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$