Skip to content

Commit 266a688

Browse files
nikolinaspeharivicac
authored andcommitted
538 - docs - generated
1 parent 731a787 commit 266a688

File tree

208 files changed

+2124
-174
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

208 files changed

+2124
-174
lines changed

docs/content/docs/reference/components/accelo_v1.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Version: 1
3333

3434

3535

36+
3637
<hr />
3738

3839

@@ -101,6 +102,8 @@ Type: OBJECT
101102
```
102103

103104

105+
106+
104107
### Create Contact
105108
Name: createContact
106109

@@ -167,6 +170,8 @@ Type: OBJECT
167170
```
168171

169172

173+
174+
170175
### Create Task
171176
Name: createTask
172177

@@ -231,6 +236,8 @@ Type: OBJECT
231236

232237

233238

239+
240+
234241
## What to do if your action is not listed here?
235242

236243
If this component doesn't have the action you need, you can use **Custom Action** to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

docs/content/docs/reference/components/active-campaign_v1.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Version: 1
3333

3434

3535

36+
3637
<hr />
3738

3839

@@ -93,6 +94,8 @@ Type: OBJECT
9394
```
9495

9596

97+
98+
9699
### Create Contact
97100
Name: createContact
98101

@@ -151,6 +154,8 @@ Type: OBJECT
151154
```
152155

153156

157+
158+
154159
### Create Task
155160
Name: createTask
156161

@@ -211,6 +216,8 @@ Type: OBJECT
211216

212217

213218

219+
220+
214221
## What to do if your action is not listed here?
215222

216223
If this component doesn't have the action you need, you can use **Custom Action** to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
@@ -231,6 +238,6 @@ To create a Custom Action, simply specify the desired HTTP method, path, and any
231238
4. Here you can see your **API Access Key** and your **API Access URL** from which you can read out your account name.
232239
5. Done 🚀.
233240

234-
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
241+
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 49, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
235242
<iframe src="https://www.guidejar.com/embed/4f5e4c93-f9e9-43d3-84ff-46a1ec62f7a7?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0, border: 'none'}} allowFullScreen></iframe>
236243
</div>

docs/content/docs/reference/components/acumbamail_v1.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Version: 1
3131

3232

3333

34+
3435
<hr />
3536

3637

@@ -73,6 +74,8 @@ Type: INTEGER
7374

7475

7576

77+
78+
7679
### Delete Subscriber
7780
Name: deleteSubscriber
7881

@@ -105,6 +108,8 @@ This action does not produce any output.
105108

106109

107110

111+
112+
108113
### Create Subscriber List
109114
Name: createSubscriberList
110115

@@ -153,6 +158,8 @@ Type: INTEGER
153158

154159

155160

161+
162+
156163
### Delete Subscriber List
157164
Name: deleteSubscriberList
158165

@@ -185,6 +192,8 @@ This action does not produce any output.
185192

186193

187194

195+
196+
188197
## What to do if your action is not listed here?
189198

190199
If this component doesn't have the action you need, you can use **Custom Action** to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
@@ -201,6 +210,6 @@ To create a Custom Action, simply specify the desired HTTP method, path, and any
201210
2. Log in to your account.
202211
3. Copy the auth token. Use these credentials to create a connection in ByteChef.
203212

204-
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
213+
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 49, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
205214
<iframe src="https://www.guidejar.com/embed/mVotYQrVYC6y0NA3uTZf?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowFullScreen frameBorder="0"></iframe>
206215
</div>

docs/content/docs/reference/components/affinity_v1.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Version: 1
3131

3232

3333

34+
3435
<hr />
3536

3637

@@ -86,6 +87,8 @@ Type: OBJECT
8687
```
8788

8889

90+
91+
8992
### Create Organization
9093
Name: createOrganization
9194

@@ -139,6 +142,8 @@ Type: OBJECT
139142
```
140143

141144

145+
146+
142147
### Create Person
143148
Name: createPerson
144149

@@ -198,6 +203,8 @@ Type: OBJECT
198203

199204

200205

206+
207+
201208
## What to do if your action is not listed here?
202209

203210
If this component doesn't have the action you need, you can use **Custom Action** to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

docs/content/docs/reference/components/agile-crm_v1.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Version: 1
3333

3434

3535

36+
3637
<hr />
3738

3839

@@ -197,6 +198,8 @@ Type: OBJECT
197198
```
198199

199200

201+
202+
200203
### Create Deal
201204
Name: crateDeal
202205

@@ -332,6 +335,8 @@ Type: OBJECT
332335
```
333336

334337

338+
339+
335340
### Create Task
336341
Name: createTask
337342

@@ -433,6 +438,8 @@ Type: OBJECT
433438

434439

435440

441+
442+
436443
## Triggers
437444

438445

@@ -488,6 +495,7 @@ Type: OBJECT
488495

489496

490497

498+
491499
<hr />
492500

493501
# Additional Instructions
@@ -502,6 +510,6 @@ Type: OBJECT
502510
4. Click on **Developers & API**.
503511
5. Click on REST API.
504512

505-
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
513+
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 49, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
506514
<iframe src="https://www.guidejar.com/embed/5a82d645-7647-462e-a2a2-0723cc61fff3?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0, border: 'none'}} allowFullScreen></iframe>
507515
</div>

docs/content/docs/reference/components/aha_v1.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Version: 1
3333

3434

3535

36+
3637
<hr />
3738

3839

@@ -121,6 +122,8 @@ Type: OBJECT
121122
```
122123

123124

125+
126+
124127
### Create Idea
125128
Name: createIdea
126129

@@ -226,6 +229,8 @@ Type: OBJECT
226229

227230

228231

232+
233+
229234
## What to do if your action is not listed here?
230235

231236
If this component doesn't have the action you need, you can use **Custom Action** to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
@@ -253,6 +258,6 @@ To create a Custom Action, simply specify the desired HTTP method, path, and any
253258
9. Here you can see your credentials.
254259
10. Done 🚀.
255260

256-
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
261+
<div style={{ position: 'relative', height:0, width: '100%', overflow: 'hidden', zIndex: 49, boxSizing: 'border-box', paddingBottom: 'calc(50.05219207% + 32px)'}}>
257262
<iframe src="https://www.guidejar.com/embed/739b69f7-a2e8-44de-9a31-1957c6c67f9c?type=1&controls=on" width="100%" height="100%" style={{height:'100%', position:'absolute', inset:0}} allowFullScreen frameBorder="0"></iframe>
258263
</div>

docs/content/docs/reference/components/ahrefs_v1.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Version: 1
3131

3232

3333

34+
3435
<hr />
3536

3637

@@ -103,6 +104,8 @@ Type: OBJECT
103104
```
104105

105106

107+
108+
106109
### Get Subscription Information
107110
Name: getSubscriptionInfo
108111

@@ -149,6 +152,8 @@ Type: OBJECT
149152
```
150153

151154

155+
156+
152157
### Get Page Content
153158
Name: getPageContent
154159

@@ -207,3 +212,5 @@ Type: OBJECT
207212

208213

209214

215+
216+

docs/content/docs/reference/components/ai-agent_v1.mdx

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,66 @@ The output for this action is dynamic and may vary depending on the input parame
7878

7979

8080

81+
### Chat (stream)
82+
Name: streamChat
83+
84+
`Chat with the AI agent and stream the response.`
85+
86+
#### Properties
87+
88+
| Name | Label | Type | Description | Required |
89+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
90+
| format | Format | STRING <details> <summary> Options </summary> <span title="User prompt and optional system prompt.">SIMPLE</span>, <span title="Full control over the messages sent to the model.">ADVANCED</span> </details> | Format of providing the prompt to the model. | true |
91+
| userPrompt | Prompt | STRING | User prompt to the model. | true |
92+
| systemPrompt | System Prompt | STRING | System prompt to the model. | false |
93+
| attachments | Attachments | ARRAY <details> <summary> Items </summary> [FILE_ENTRY] </details> | Only text and image files are supported. Also, only certain models supports images. Please check the documentation. | false |
94+
| messages | Messages | ARRAY <details> <summary> Items </summary> [&#123;STRING\(role), STRING\(content), [FILE_ENTRY]\(attachments)&#125;] </details> | A list of messages comprising the conversation so far. | true |
95+
| response | Response | OBJECT <details> <summary> Properties </summary> &#123;STRING\(responseFormat), STRING\(responseSchema)&#125; </details> | The response from the API. | true |
96+
| conversationId | null | STRING | The conversation id used in conjunction with memory. | false |
97+
98+
#### Example JSON Structure
99+
```json
100+
{
101+
"label" : "Chat (stream)",
102+
"name" : "streamChat",
103+
"parameters" : {
104+
"format" : "",
105+
"userPrompt" : "",
106+
"systemPrompt" : "",
107+
"attachments" : [ {
108+
"extension" : "",
109+
"mimeType" : "",
110+
"name" : "",
111+
"url" : ""
112+
} ],
113+
"messages" : [ {
114+
"role" : "",
115+
"content" : "",
116+
"attachments" : [ {
117+
"extension" : "",
118+
"mimeType" : "",
119+
"name" : "",
120+
"url" : ""
121+
} ]
122+
} ],
123+
"response" : {
124+
"responseFormat" : "",
125+
"responseSchema" : ""
126+
},
127+
"conversationId" : ""
128+
},
129+
"type" : "aiAgent/v1/streamChat"
130+
}
131+
```
132+
133+
#### Output
134+
135+
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
136+
137+
138+
139+
140+
141+
142+
143+

docs/content/docs/reference/components/ai-image_v1.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,5 @@ Type: OBJECT
8383

8484

8585

86+
87+

0 commit comments

Comments
 (0)