Skip to content

🌿 ✨ [Scheduled] Update API Spec #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

🌿 ✨ [Scheduled] Update API Spec #145

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dded13b
feat(api): add Gemini Flash 2.0 Multimodal Live API support
fern-api[bot] Jan 8, 2025
bf46e67
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
fern-api[bot] Jan 9, 2025
acaa203
feat(openapi): Add new credential types and Azure blob storage
fern-api[bot] Jan 9, 2025
f8083b0
feat(openapi): update OpenAPI spec to support multiple providers for …
fern-api[bot] Jan 11, 2025
554a319
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
fern-api[bot] Jan 12, 2025
c9712d5
feat(openapi): add new tool types and improve tool configuration
fern-api[bot] Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 257 additions & 0 deletions fern/apis/api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26601,6 +26601,263 @@
"metadata"
]
},
"BashToolWithToolCall": {
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
"example": false
},
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ToolMessageStart",
"title": "ToolMessageStart"
},
{
"$ref": "#/components/schemas/ToolMessageComplete",
"title": "ToolMessageComplete"
},
{
"$ref": "#/components/schemas/ToolMessageFailed",
"title": "ToolMessageFailed"
},
{
"$ref": "#/components/schemas/ToolMessageDelayed",
"title": "ToolMessageDelayed"
}
]
}
},
"type": {
"type": "string",
"enum": [
"bash"
],
"description": "The type of tool. \"bash\" for Bash tool."
},
"subType": {
"type": "string",
"enum": [
"bash_20241022"
],
"description": "The sub type of tool."
},
"toolCall": {
"$ref": "#/components/schemas/ToolCall"
},
"name": {
"type": "string",
"description": "The name of the tool, fixed to 'bash'",
"default": "bash",
"enum": [
"bash"
]
},
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
"$ref": "#/components/schemas/OpenAIFunction"
}
]
},
"server": {
"description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.",
"allOf": [
{
"$ref": "#/components/schemas/Server"
}
]
}
},
"required": [
"type",
"subType",
"toolCall",
"name"
]
},
"ComputerToolWithToolCall": {
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
"example": false
},
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ToolMessageStart",
"title": "ToolMessageStart"
},
{
"$ref": "#/components/schemas/ToolMessageComplete",
"title": "ToolMessageComplete"
},
{
"$ref": "#/components/schemas/ToolMessageFailed",
"title": "ToolMessageFailed"
},
{
"$ref": "#/components/schemas/ToolMessageDelayed",
"title": "ToolMessageDelayed"
}
]
}
},
"type": {
"type": "string",
"enum": [
"computer"
],
"description": "The type of tool. \"computer\" for Computer tool."
},
"subType": {
"type": "string",
"enum": [
"computer_20241022"
],
"description": "The sub type of tool."
},
"toolCall": {
"$ref": "#/components/schemas/ToolCall"
},
"name": {
"type": "string",
"description": "The name of the tool, fixed to 'computer'",
"default": "computer",
"enum": [
"computer"
]
},
"displayWidthPx": {
"type": "number",
"description": "The display width in pixels"
},
"displayHeightPx": {
"type": "number",
"description": "The display height in pixels"
},
"displayNumber": {
"type": "number",
"description": "Optional display number"
},
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
"$ref": "#/components/schemas/OpenAIFunction"
}
]
},
"server": {
"description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.",
"allOf": [
{
"$ref": "#/components/schemas/Server"
}
]
}
},
"required": [
"type",
"subType",
"toolCall",
"name",
"displayWidthPx",
"displayHeightPx"
]
},
"TextEditorToolWithToolCall": {
"type": "object",
"properties": {
"async": {
"type": "boolean",
"description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
"example": false
},
"messages": {
"type": "array",
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ToolMessageStart",
"title": "ToolMessageStart"
},
{
"$ref": "#/components/schemas/ToolMessageComplete",
"title": "ToolMessageComplete"
},
{
"$ref": "#/components/schemas/ToolMessageFailed",
"title": "ToolMessageFailed"
},
{
"$ref": "#/components/schemas/ToolMessageDelayed",
"title": "ToolMessageDelayed"
}
]
}
},
"type": {
"type": "string",
"enum": [
"textEditor"
],
"description": "The type of tool. \"textEditor\" for Text Editor tool."
},
"subType": {
"type": "string",
"enum": [
"text_editor_20241022"
],
"description": "The sub type of tool."
},
"toolCall": {
"$ref": "#/components/schemas/ToolCall"
},
"name": {
"type": "string",
"description": "The name of the tool, fixed to 'str_replace_editor'",
"default": "str_replace_editor",
"enum": [
"str_replace_editor"
]
},
"function": {
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
"allOf": [
{
"$ref": "#/components/schemas/OpenAIFunction"
}
]
},
"server": {
"description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.",
"allOf": [
{
"$ref": "#/components/schemas/Server"
}
]
}
},
"required": [
"type",
"subType",
"toolCall",
"name"
]
},
"StepDestination": {
"type": "object",
"properties": {
Expand Down
Loading