Start a provider OAuth or device flow

POST

/api/inference/providers/oauth/start

curl --request POST \
  --url https://gateway.example.com/api/inference/providers/oauth/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "providerId": "example", "connectionName": "example", "acceptTerms": true, "termsVersion": "example" }'

• Your Gateway instance

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

providerId

required

string

>= 1 characters <= 80 characters

connectionName

required

string

>= 1 characters <= 255 characters

acceptTerms

required

boolean

termsVersion

string

<= 80 characters

Example^generated

{
  "providerId": "example",
  "connectionName": "example",
  "acceptTerms": true,
  "termsVersion": "example"
}

Responses

201

Created

Media typeapplication/json

object

id

required

string format: uuid

providerId

required

string

status

required

string

Allowed values: pending complete error expired cancelled

authorizationUrl

required

string

completionMode

required

string

userCode

string | null

pollIntervalSeconds

integer | null

connectionId

string | null format: uuid

errorCode

string | null

errorMessage

string | null

expiresAt

required

string format: date-time

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

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

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

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

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

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

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

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"
}