Skip to main content
POST
/
connection
/
connectors
Create connector
curl --request POST \
  --url https://api.getcargo.io/v1/connection/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "integrationSlug": "<string>",
  "config": {},
  "rateLimit": {
    "unit": "day",
    "max": 123
  },
  "cacheTtlMilliseconds": 123
}
'
{
  "connector": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "userUuid": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "rateLimit": {
      "unit": "day",
      "max": 123
    },
    "cacheTtlMilliseconds": 123,
    "integrationSlug": "<string>",
    "playsCount": 123,
    "toolsCount": 123,
    "modelsCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "useCredits": true,
    "config": "<unknown>"
  },
  "dataset": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "slug": "<string>",
    "config": {
      "kind": "<string>",
      "connectorUuid": "<string>"
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

name
string
required

Connector name.

slug
string
required

Connector slug.

integrationSlug
string
required

Integration identifier.

config
Config · object

Connector configuration.

rateLimit
Rate limit · object

Rate limit configuration.

cacheTtlMilliseconds
number

Cache time-to-live in milliseconds.

Response

Successful response

connector
Connector · object
required

Connector details.

dataset
Dataset · object
required

Created dataset details.