Skip to content
OpfieldOpfieldOpfield

Connect an API-key or local inference provider

POST
/api/inference/providers/connections
curl --request POST \
  --url https://gateway.example.com/api/inference/providers/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "providerId": "example", "name": "example", "authType": "api_key", "apiKey": "example", "baseUrl": "example", "allowPrivateNetwork": false }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

JSON request body

Media typeapplication/json
object
providerId
required
string
>= 1 characters <= 80 characters
name
required
string
>= 1 characters <= 255 characters
authType
string
default: api_key
Allowed values: api_key local
apiKey
string
>= 1 characters <= 16384 characters
baseUrl
string
<= 2048 characters
allowPrivateNetwork
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
id
required
string format: uuid
providerId
required
string
name
required
string
authType
required
string
Allowed values: oauth api_key local
baseUrl
required
string
accountExternalId
required
string | null
accountLabel
required
string | null
enabled
required
boolean
routingOrder
required
integer
minimumRemainingPercent
required
integer
>= 1 <= 100
apiMonthlyLimitMicrodollars
required
integer | null
apiMonthlySpentMicrodollars
required
integer
status
required
string
Allowed values: pending healthy quota_hot cooldown stale reauth_required unavailable disabled
healthReason
required
string | null
syncStatus
required
string
Allowed values: never running success error
syncLastError
required
string | null
lastSyncedAt
required
string | null format: date-time
nextSyncAt
required
string | null format: date-time
metadata
required
object
key
additional properties
createdBy
required
string | null format: uuid
deletedAt
required
string | null format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
credential
required
object
connectionId
required
string format: uuid
kind
required
string
last4
required
string | null
expiresAt
required
string | null
discoveredModels
required
Array<object>
object
key
additional properties
quota
required
Array<object>
object
key
additional properties
Example
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Section titled “400”

Bad request

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Section titled “401”

Authentication required

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Section titled “422”

Unprocessable entity

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}