Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Create a Connection
Creates a Connection in a Project.
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/connections \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "some name",
"isDeprecated": true,
"type": "http_basic",
"extension": "@cognigy/basic-nodes",
"fields": {
"some-key-from-connection-schema": "x123sdfu12312"
},
"projectId": "<string>"
}
'{
"key": "some-key-from-connection-schema",
"value": "x123w123",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Body
- Option 1
- Option 2
Either projectId or resourceLevel: organization must be present in the request body.
"some name"
Marked 'true' if the connection type is deprecated
"http_basic"
"@cognigy/basic-nodes"
The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.
{
"some-key-from-connection-schema": "x123sdfu12312"
}
The unique identifier for the Project.
24^[a-z0-9]{24}$Response
Returns Connection metadata object.
The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
The key of the connection field. The key should match the connection schema of the specific connection type.
"some-key-from-connection-schema"
The value of the connection field
"x123w123"
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/connections \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "some name",
"isDeprecated": true,
"type": "http_basic",
"extension": "@cognigy/basic-nodes",
"fields": {
"some-key-from-connection-schema": "x123sdfu12312"
},
"projectId": "<string>"
}
'{
"key": "some-key-from-connection-schema",
"value": "x123w123",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}