OpenAi
Create OpenAI Integration
By configuring this integration, the system will be able to interact with OpenAI services to power AI-driven features such as automated responses, content generation, and intelligent workflows within the selected environment.
Endpoint: POST/integrations
Request Body
| Field | Type | Description |
|---|---|---|
| integration | integer | Unique identifier of the integration type to be configured. |
| data | object | Configuration object containing service-specific parameters. |
| data.environment | string | Defines the operational environment. • stage: Staging/testing environment. • production: Live production environment. |
| data.changeKeys | boolean | Indicates if the system should automatically map field keys during data exchange with the AI service. |
Request Example
{
"integration": 7,
"data": {
"environment": "stage",
"changeKeys": false
}
}Response Example
{
"id": 108,
"data": {
"changeKeys": false,
"environment": "stage"
},
"integration": {
"id": 7,
"name": "OpenAI",
"description": "integrations.openai.description",
"category": "integrations.openai.category",
"slug": "openai",
"created_at": "2025-06-17T15:40:10.483Z",
"updated_at": "2025-06-17T15:40:10.483Z",
"media": []
},
"status": "active",
"created_at": "2026-03-12T20:59:59.404Z",
"updated_at": "2026-03-12T20:59:59.412Z"
}Response Fields
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the created integration configuration. |
| integration | integer | Identifier of the integration type configured. |
| status | string | Current operational status of the integration. • active: Enabled and operational. • inactive: Currently disabled. |
| data | object | An object containing the applied configuration parameters. |
| created_at | datetime | ISO 8601 timestamp indicating when the integration was created. |
| updated_at | datetime | ISO 8601 timestamp indicating the last update to the configuration. |