syllable-sdk 1.0.7 → 1.0.8-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/bin/mcp-server.js +54 -17
  2. package/bin/mcp-server.js.map +11 -10
  3. package/examples/package-lock.json +1 -1
  4. package/funcs/directoryUpdate.js +3 -1
  5. package/funcs/directoryUpdate.js.map +1 -1
  6. package/jsr.json +1 -1
  7. package/lib/config.d.ts +3 -3
  8. package/lib/config.js +3 -3
  9. package/lib/config.js.map +1 -1
  10. package/mcp-server/mcp-server.js +1 -1
  11. package/mcp-server/mcp-server.js.map +1 -1
  12. package/mcp-server/server.js +1 -1
  13. package/mcp-server/server.js.map +1 -1
  14. package/models/components/directorymember.d.ts +4 -4
  15. package/models/components/directorymember.d.ts.map +1 -1
  16. package/models/components/directorymember.js +4 -4
  17. package/models/components/directorymember.js.map +1 -1
  18. package/models/components/directorymemberupdate.d.ts +60 -0
  19. package/models/components/directorymemberupdate.d.ts.map +1 -0
  20. package/models/components/directorymemberupdate.js +87 -0
  21. package/models/components/directorymemberupdate.js.map +1 -0
  22. package/models/components/index.d.ts +1 -0
  23. package/models/components/index.d.ts.map +1 -1
  24. package/models/components/index.js +1 -0
  25. package/models/components/index.js.map +1 -1
  26. package/models/operations/directorymemberupdate.d.ts +2 -2
  27. package/models/operations/directorymemberupdate.d.ts.map +1 -1
  28. package/models/operations/directorymemberupdate.js +4 -4
  29. package/models/operations/directorymemberupdate.js.map +1 -1
  30. package/openapi.json +136 -52
  31. package/package.json +1 -1
  32. package/src/funcs/directoryUpdate.ts +3 -1
  33. package/src/lib/config.ts +3 -3
  34. package/src/mcp-server/mcp-server.ts +1 -1
  35. package/src/mcp-server/server.ts +1 -1
  36. package/src/models/components/directorymember.ts +8 -10
  37. package/src/models/components/directorymemberupdate.ts +115 -0
  38. package/src/models/components/index.ts +1 -0
  39. package/src/models/operations/directorymemberupdate.ts +6 -6
  40. package/.devcontainer/README.md +0 -35
  41. package/api-reference/sdks/agents/README.md +0 -224
  42. package/api-reference/sdks/availabletargets/README.md +0 -49
  43. package/api-reference/sdks/channels/README.md +0 -92
  44. package/api-reference/sdks/chats/README.md +0 -55
  45. package/api-reference/sdks/conversations/README.md +0 -91
  46. package/api-reference/sdks/dashboards/README.md +0 -321
  47. package/api-reference/sdks/events/README.md +0 -50
  48. package/api-reference/sdks/greetings/README.md +0 -223
  49. package/api-reference/sdks/organizations/README.md +0 -48
  50. package/api-reference/sdks/prompts/README.md +0 -225
  51. package/api-reference/sdks/sessions/README.md +0 -50
  52. package/api-reference/sdks/syllable/README.md +0 -22
  53. package/api-reference/sdks/targets/README.md +0 -194
  54. package/api-reference/sdks/tools/README.md +0 -92
  55. package/docs/sdks/agents/README.md +0 -589
  56. package/docs/sdks/batches/README.md +0 -742
  57. package/docs/sdks/campaigns/README.md +0 -526
  58. package/docs/sdks/channels/README.md +0 -401
  59. package/docs/sdks/conversations/README.md +0 -100
  60. package/docs/sdks/custommessages/README.md +0 -496
  61. package/docs/sdks/dashboards/README.md +0 -481
  62. package/docs/sdks/datasources/README.md +0 -458
  63. package/docs/sdks/directory/README.md +0 -731
  64. package/docs/sdks/events/README.md +0 -100
  65. package/docs/sdks/folders/README.md +0 -675
  66. package/docs/sdks/fullsummary/README.md +0 -82
  67. package/docs/sdks/incidents/README.md +0 -501
  68. package/docs/sdks/insights/README.md +0 -100
  69. package/docs/sdks/languagegroups/README.md +0 -565
  70. package/docs/sdks/latency/README.md +0 -82
  71. package/docs/sdks/numbers/README.md +0 -250
  72. package/docs/sdks/organizations/README.md +0 -317
  73. package/docs/sdks/permissions/README.md +0 -78
  74. package/docs/sdks/prompts/README.md +0 -592
  75. package/docs/sdks/pronunciations/README.md +0 -360
  76. package/docs/sdks/roles/README.md +0 -430
  77. package/docs/sdks/services/README.md +0 -430
  78. package/docs/sdks/sessiondebug/README.md +0 -236
  79. package/docs/sdks/sessionlabels/README.md +0 -262
  80. package/docs/sdks/sessions/README.md +0 -325
  81. package/docs/sdks/syllablesdktools/README.md +0 -578
  82. package/docs/sdks/takeouts/README.md +0 -228
  83. package/docs/sdks/targets/README.md +0 -454
  84. package/docs/sdks/test/README.md +0 -92
  85. package/docs/sdks/tools/README.md +0 -518
  86. package/docs/sdks/transcript/README.md +0 -82
  87. package/docs/sdks/twilio/README.md +0 -246
  88. package/docs/sdks/users/README.md +0 -561
  89. package/docs/sdks/v1/README.md +0 -561
  90. package/docs/sdks/voicegroups/README.md +0 -551
  91. package/docs/sdks/workflows/README.md +0 -781
  92. package/examples/README.md +0 -31
package/api-reference/sdks/prompts/README.md DELETED
@@ -1,225 +0,0 @@
1
- # Prompts
2
- (*prompts*)
3
-
4
- ## Overview
5
-
6
- Operations related to prompts
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Prompt List
11
- * [create](#create) - Create Prompt
12
- * [update](#update) - Update Prompt
13
- * [get_by_id](#get_by_id) - Get Prompt By Id
14
- * [delete](#delete) - Delete Prompt
15
-
16
- ## list
17
-
18
- List the existing prompts
19
-
20
- ### Example Usage
21
-
22
- ```python
23
- import os
24
- from syllable_sdk import Syllable
25
-
26
- s = Syllable(
27
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
28
- )
29
-
30
- res = s.prompts.list()
31
-
32
- if res is not None:
33
- # handle response
34
- pass
35
-
36
- ```
37
-
38
- ### Parameters
39
-
40
- | Parameter | Type | Required | Description |
41
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
42
- | `filter_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
43
- | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
44
- | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A |
45
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
46
-
47
- ### Response
48
-
49
- **[models.PromptListResponse](../../models/promptlistresponse.md)**
50
-
51
- ### Errors
52
-
53
- | Error Type | Status Code | Content Type |
54
- | -------------------------- | -------------------------- | -------------------------- |
55
- | models.HTTPValidationError | 422 | application/json |
56
- | models.SDKError | 4XX, 5XX | \*/\* |
57
-
58
- ## create
59
-
60
- Create a new prompt
61
-
62
- ### Example Usage
63
-
64
- ```python
65
- import os
66
- from syllable_sdk import Syllable
67
-
68
- s = Syllable(
69
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
70
- )
71
-
72
- res = s.prompts.create(request={
73
- "name": "<value>",
74
- "llm_config": {},
75
- })
76
-
77
- if res is not None:
78
- # handle response
79
- pass
80
-
81
- ```
82
-
83
- ### Parameters
84
-
85
- | Parameter | Type | Required | Description |
86
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
87
- | `request` | [models.PromptCreate](../../models/promptcreate.md) | :heavy_check_mark: | The request object to use for the request. |
88
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
89
-
90
- ### Response
91
-
92
- **[models.Prompt](../../models/prompt.md)**
93
-
94
- ### Errors
95
-
96
- | Error Type | Status Code | Content Type |
97
- | -------------------------- | -------------------------- | -------------------------- |
98
- | models.HTTPValidationError | 422 | application/json |
99
- | models.SDKError | 4XX, 5XX | \*/\* |
100
-
101
- ## update
102
-
103
- Update an existing prompt
104
-
105
- ### Example Usage
106
-
107
- ```python
108
- import os
109
- from syllable_sdk import Syllable
110
-
111
- s = Syllable(
112
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
113
- )
114
-
115
- res = s.prompts.update(request={
116
- "name": "<value>",
117
- "llm_config": {},
118
- "id": 857478,
119
- "last_updated": "<value>",
120
- })
121
-
122
- if res is not None:
123
- # handle response
124
- pass
125
-
126
- ```
127
-
128
- ### Parameters
129
-
130
- | Parameter | Type | Required | Description |
131
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
132
- | `request` | [models.Prompt](../../models/prompt.md) | :heavy_check_mark: | The request object to use for the request. |
133
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
134
-
135
- ### Response
136
-
137
- **[models.Prompt](../../models/prompt.md)**
138
-
139
- ### Errors
140
-
141
- | Error Type | Status Code | Content Type |
142
- | -------------------------- | -------------------------- | -------------------------- |
143
- | models.HTTPValidationError | 422 | application/json |
144
- | models.SDKError | 4XX, 5XX | \*/\* |
145
-
146
- ## get_by_id
147
-
148
- Get a prompt by ID
149
-
150
- ### Example Usage
151
-
152
- ```python
153
- import os
154
- from syllable_sdk import Syllable
155
-
156
- s = Syllable(
157
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
158
- )
159
-
160
- res = s.prompts.get_by_id(prompt_id=931598)
161
-
162
- if res is not None:
163
- # handle response
164
- pass
165
-
166
- ```
167
-
168
- ### Parameters
169
-
170
- | Parameter | Type | Required | Description |
171
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
172
- | `prompt_id` | *int* | :heavy_check_mark: | N/A |
173
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
174
-
175
- ### Response
176
-
177
- **[models.Prompt](../../models/prompt.md)**
178
-
179
- ### Errors
180
-
181
- | Error Type | Status Code | Content Type |
182
- | -------------------------- | -------------------------- | -------------------------- |
183
- | models.HTTPValidationError | 422 | application/json |
184
- | models.SDKError | 4XX, 5XX | \*/\* |
185
-
186
- ## delete
187
-
188
- Delete an prompt by ID
189
-
190
- ### Example Usage
191
-
192
- ```python
193
- import os
194
- from syllable_sdk import Syllable
195
-
196
- s = Syllable(
197
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
198
- )
199
-
200
- res = s.prompts.delete(prompt_id=426520, reason="<value>")
201
-
202
- if res is not None:
203
- # handle response
204
- pass
205
-
206
- ```
207
-
208
- ### Parameters
209
-
210
- | Parameter | Type | Required | Description |
211
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
212
- | `prompt_id` | *int* | :heavy_check_mark: | N/A |
213
- | `reason` | *str* | :heavy_check_mark: | N/A |
214
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
215
-
216
- ### Response
217
-
218
- **[Any](../../models/.md)**
219
-
220
- ### Errors
221
-
222
- | Error Type | Status Code | Content Type |
223
- | -------------------------- | -------------------------- | -------------------------- |
224
- | models.HTTPValidationError | 422 | application/json |
225
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/sessions/README.md DELETED
@@ -1,50 +0,0 @@
1
- # Sessions
2
- (*sessions*)
3
-
4
- ## Overview
5
-
6
- Operations related to agent sessions
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Sessions List
11
-
12
- ## list
13
-
14
- Sessions List
15
-
16
- ### Example Usage
17
-
18
- ```python
19
- import os
20
- from syllable_sdk import Syllable
21
-
22
- s = Syllable(
23
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
24
- )
25
-
26
- res = s.sessions.list()
27
-
28
- if res is not None:
29
- # handle response
30
- pass
31
-
32
- ```
33
-
34
- ### Parameters
35
-
36
- | Parameter | Type | Required | Description |
37
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
38
- | `request` | [models.SessionsListRequest](../../models/sessionslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
39
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
40
-
41
- ### Response
42
-
43
- **[models.SessionListResponse](../../models/sessionlistresponse.md)**
44
-
45
- ### Errors
46
-
47
- | Error Type | Status Code | Content Type |
48
- | -------------------------- | -------------------------- | -------------------------- |
49
- | models.HTTPValidationError | 422 | application/json |
50
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/syllable/README.md DELETED
@@ -1,22 +0,0 @@
1
- # Syllable SDK
2
-
3
- ## Overview
4
-
5
- SyllableSDK:
6
- # Syllble Platform SDK
7
-
8
- Syllble SDK gives you the power of awesome AI agentry. 🚀
9
-
10
- ## Overview
11
-
12
- The Syllble SDK provides a comprehensive set of tools and APIs to integrate powerful AI capabilities into your applications. Whether you're building chatbots, virtual assistants, or any other AI-driven solutions, Syllble SDK has got you covered.
13
-
14
- ## Features
15
-
16
- - **Natural Language Processing (NLP)**: Understand and generate human language with ease.
17
- - **Machine Learning Models**: Leverage pre-trained models or train your own custom models.
18
- - **Speech Recognition**: Convert speech to text and vice versa.
19
- - **Image Recognition**: Identify objects, faces, and scenes in images.
20
- - **Data Analytics**: Analyze and visualize data to gain insights.
21
- - **Integration**: Seamlessly integrate with other services and platforms.
22
-
package/api-reference/sdks/targets/README.md DELETED
@@ -1,194 +0,0 @@
1
- # Targets
2
- (*channels.targets*)
3
-
4
- ## Overview
5
-
6
- Operations related to channel targets
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Get Channel Targets
11
- * [create](#create) - Assign A Channel Target
12
- * [get_by_id](#get_by_id) - Get A Channel Target
13
- * [update](#update) - Edit Channel Target
14
-
15
- ## list
16
-
17
- Get Channel Targets
18
-
19
- ### Example Usage
20
-
21
- ```python
22
- import os
23
- from syllable_sdk import Syllable
24
-
25
- s = Syllable(
26
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
27
- )
28
-
29
- res = s.channels.targets.list()
30
-
31
- if res is not None:
32
- # handle response
33
- pass
34
-
35
- ```
36
-
37
- ### Parameters
38
-
39
- | Parameter | Type | Required | Description |
40
- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
41
- | `request` | [models.ChannelTargetsListRequest](../../models/channeltargetslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
42
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
43
-
44
- ### Response
45
-
46
- **[models.ChannelTargetListResponse](../../models/channeltargetlistresponse.md)**
47
-
48
- ### Errors
49
-
50
- | Error Type | Status Code | Content Type |
51
- | -------------------------- | -------------------------- | -------------------------- |
52
- | models.HTTPValidationError | 422 | application/json |
53
- | models.SDKError | 4XX, 5XX | \*/\* |
54
-
55
- ## create
56
-
57
- Assign A Channel Target
58
-
59
- ### Example Usage
60
-
61
- ```python
62
- import os
63
- from syllable_sdk import Syllable
64
-
65
- s = Syllable(
66
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
67
- )
68
-
69
- res = s.channels.targets.create(channel_id=134365, channel_target_create_request={
70
- "channel_id": 486589,
71
- "channel_name": "<value>",
72
- "agent_id": 638424,
73
- "target": "<value>",
74
- "target_mode": "<value>",
75
- "fallback_target": "<value>",
76
- "is_test": True,
77
- })
78
-
79
- if res is not None:
80
- # handle response
81
- pass
82
-
83
- ```
84
-
85
- ### Parameters
86
-
87
- | Parameter | Type | Required | Description |
88
- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
89
- | `channel_id` | *int* | :heavy_check_mark: | N/A |
90
- | `channel_target_create_request` | [models.ChannelTargetCreateRequest](../../models/channeltargetcreaterequest.md) | :heavy_check_mark: | N/A |
91
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
92
-
93
- ### Response
94
-
95
- **[models.ChannelTarget](../../models/channeltarget.md)**
96
-
97
- ### Errors
98
-
99
- | Error Type | Status Code | Content Type |
100
- | -------------------------- | -------------------------- | -------------------------- |
101
- | models.HTTPValidationError | 422 | application/json |
102
- | models.SDKError | 4XX, 5XX | \*/\* |
103
-
104
- ## get_by_id
105
-
106
- Get A Channel Target
107
-
108
- ### Example Usage
109
-
110
- ```python
111
- import os
112
- from syllable_sdk import Syllable
113
-
114
- s = Syllable(
115
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
116
- )
117
-
118
- res = s.channels.targets.get_by_id(channel_id=931598, target_id=505057)
119
-
120
- if res is not None:
121
- # handle response
122
- pass
123
-
124
- ```
125
-
126
- ### Parameters
127
-
128
- | Parameter | Type | Required | Description |
129
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
130
- | `channel_id` | *int* | :heavy_check_mark: | N/A |
131
- | `target_id` | *int* | :heavy_check_mark: | N/A |
132
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
133
-
134
- ### Response
135
-
136
- **[models.ChannelTarget](../../models/channeltarget.md)**
137
-
138
- ### Errors
139
-
140
- | Error Type | Status Code | Content Type |
141
- | -------------------------- | -------------------------- | -------------------------- |
142
- | models.HTTPValidationError | 422 | application/json |
143
- | models.SDKError | 4XX, 5XX | \*/\* |
144
-
145
- ## update
146
-
147
- Update channel target by ID
148
-
149
- ### Example Usage
150
-
151
- ```python
152
- import os
153
- from syllable_sdk import Syllable
154
-
155
- s = Syllable(
156
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
157
- )
158
-
159
- res = s.channels.targets.update(channel_id=627690, target_id=488852, channel_target={
160
- "id": 857478,
161
- "channel_id": 597129,
162
- "channel_name": "<value>",
163
- "agent_id": 344620,
164
- "target": "<value>",
165
- "target_mode": "<value>",
166
- "fallback_target": "<value>",
167
- "is_test": False,
168
- })
169
-
170
- if res is not None:
171
- # handle response
172
- pass
173
-
174
- ```
175
-
176
- ### Parameters
177
-
178
- | Parameter | Type | Required | Description |
179
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
180
- | `channel_id` | *int* | :heavy_check_mark: | N/A |
181
- | `target_id` | *int* | :heavy_check_mark: | N/A |
182
- | `channel_target` | [models.ChannelTarget](../../models/channeltarget.md) | :heavy_check_mark: | N/A |
183
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
184
-
185
- ### Response
186
-
187
- **[models.ChannelTarget](../../models/channeltarget.md)**
188
-
189
- ### Errors
190
-
191
- | Error Type | Status Code | Content Type |
192
- | -------------------------- | -------------------------- | -------------------------- |
193
- | models.HTTPValidationError | 422 | application/json |
194
- | models.SDKError | 4XX, 5XX | \*/\* |
package/api-reference/sdks/tools/README.md DELETED
@@ -1,92 +0,0 @@
1
- # Tools
2
- (*tools*)
3
-
4
- ## Overview
5
-
6
- Operations related to tools
7
-
8
- ### Available Operations
9
-
10
- * [list](#list) - Tool List
11
- * [get_by_name](#get_by_name) - Tool Info
12
-
13
- ## list
14
-
15
- List the existing agents
16
-
17
- ### Example Usage
18
-
19
- ```python
20
- import os
21
- from syllable_sdk import Syllable
22
-
23
- s = Syllable(
24
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
25
- )
26
-
27
- res = s.tools.list()
28
-
29
- if res is not None:
30
- # handle response
31
- pass
32
-
33
- ```
34
-
35
- ### Parameters
36
-
37
- | Parameter | Type | Required | Description |
38
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
39
- | `page` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A |
40
- | `limit` | *Optional[int]* | :heavy_minus_sign: | N/A |
41
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
42
-
43
- ### Response
44
-
45
- **[models.ToolListResponse](../../models/toollistresponse.md)**
46
-
47
- ### Errors
48
-
49
- | Error Type | Status Code | Content Type |
50
- | -------------------------- | -------------------------- | -------------------------- |
51
- | models.HTTPValidationError | 422 | application/json |
52
- | models.SDKError | 4XX, 5XX | \*/\* |
53
-
54
- ## get_by_name
55
-
56
- Get the details of a specific tool
57
-
58
- ### Example Usage
59
-
60
- ```python
61
- import os
62
- from syllable_sdk import Syllable
63
-
64
- s = Syllable(
65
- api_key_header=os.getenv("SYLLABLE_API_KEY_HEADER", ""),
66
- )
67
-
68
- res = s.tools.get_by_name(tool_name="<value>")
69
-
70
- if res is not None:
71
- # handle response
72
- pass
73
-
74
- ```
75
-
76
- ### Parameters
77
-
78
- | Parameter | Type | Required | Description |
79
- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
80
- | `tool_name` | *str* | :heavy_check_mark: | N/A |
81
- | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
82
-
83
- ### Response
84
-
85
- **[models.ToolDetailResponse](../../models/tooldetailresponse.md)**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | -------------------------- | -------------------------- | -------------------------- |
91
- | models.HTTPValidationError | 422 | application/json |
92
- | models.SDKError | 4XX, 5XX | \*/\* |