Element details
type: meya.openai.integration
class: OpenaiIntegration
path: /meya/openai/integration/integration.py
signature: -
Fields
| field | description | required | signature | default | type |
|---|---|---|---|---|---|
| spec | Override the original spec for this element. | ○ | ○ | null | Spec |
| enabled | Enables the integration, allowing it to process events and HTTP/WS entries. | ○ | ○ | true | bool |
| filter | Specifies the GridQL to filter rx_sub, rx, tx, tx_pubentries. Check the integration filtering guidefor more info. | ○ | ○ | rx_sub: true rx: true tx: true tx_pub: true | IntegrationFilter |
| verify_token | The token to be verified for each incoming request. You need to add the verify_token=YOUR_TOKEN query parameter to integration's webhook URL. | ○ | ○ | null | str |
| max_attachment_size | Controls maximum attachment size supported by the integration in bytes. | ○ | ○ | null | int |
| api_key | The OpenAI API key to use for this integration. If not provided, the integration will use Meya's OpenAI API key for all requests. You will be charged for any requests made using Meya's API key according to Meya's token usage rates. | ○ | ○ | null | str |
Usage reference
Basic
type: meya.openai.integration
Full
type: meya.openai.integration
spec:
type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
enabled: false
filter:
rx_sub: STRING
rx: STRING
tx: STRING
tx_pub: STRING
verify_token: STRING
max_attachment_size: 123
api_key: STRING