Skip to content
Olivares AI docs

List available connector types with their configuration fields

GET
/v1/console/connectors
 
curl --request GET \
  --url https://example.com/v1/console/connectors \
  --header 'Authorization: Bearer <token>'

Lists the connector types this build offers, each with the configuration fields it accepts.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
connectors
Array<object>
object
description
string
fields
Array<object>
object
default
string
description
string
key
string
required
boolean
secret
boolean
type
string
Allowed values: string int bool duration
fields_known
boolean
hosting

Where the observed system runs, DERIVED from the connector’s own declared endpoint defaults: self_hosted (its default endpoint is on the loopback host — the operator runs it), vendor_hosted (a routable vendor URL), or unknown (it declares no endpoint, or it is an out-of-process plugin the host cannot introspect). unknown is a real third answer and is never a synonym for vendor_hosted.

string
Allowed values: self_hosted vendor_hosted unknown
kind
string
title
string
transport
string
Example 
{
  "connectors": [
    {
      "fields": [
        {
          "type": "string"
        }
      ],
      "hosting": "self_hosted"
    }
  ]
}

400

Section titled “400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Section titled “409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Section titled “429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}