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": {},
  "cacheTtlMilliseconds": 123
}
'
{
  "connector": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "userUuid": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "rateLimit": {
      "max": 123
    },
    "cacheTtlMilliseconds": 123,
    "integrationSlug": "<string>",
    "playsCount": 123,
    "toolsCount": 123,
    "modelsCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "useCredits": true,
    "config": null
  },
  "dataset": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "slug": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "kind": "<string>",
    "connectorUuid": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt

Use this file to discover all available pages before exploring further.

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.

Pattern: ^[a-z0-9]+(_[a-z0-9]+)*$
​
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.