Skip to content

Update API specifications with fern api update #905

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update API specifications with fern api update #905

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
223 changes: 149 additions & 74 deletions fern/apis/api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12559,6 +12559,141 @@
"type"
]
},
"SquadMemberDTO": {
"type": "object",
"properties": {
"assistantDestinations": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TransferDestinationAssistant",
"title": "Transfer Destination"
},
{
"$ref": "#/components/schemas/HandoffDestinationAssistant",
"title": "Handoff Destination"
}
]
}
},
"assistantId": {
"type": "string",
"nullable": true,
"description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
},
"assistant": {
"description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
}
]
},
"assistantOverrides": {
"description": "This can be used to override the assistant's settings and provide values for it's template variables.",
"allOf": [
{
"$ref": "#/components/schemas/AssistantOverrides"
}
]
}
}
},
"CreateSquadDTO": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This is the name of the squad."
},
"members": {
"description": "This is the list of assistants that make up the squad.\n\nThe call will start with the first assistant in the list.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SquadMemberDTO"
}
},
"membersOverrides": {
"description": "This can be used to override all the assistants' settings and provide values for their template variables.\n\nBoth `membersOverrides` and `members[n].assistantOverrides` can be used together. First, `members[n].assistantOverrides` is applied. Then, `membersOverrides` is applied as a global override.",
"allOf": [
{
"$ref": "#/components/schemas/AssistantOverrides"
}
]
}
},
"required": [
"members"
]
},
"HandoffDestinationSquad": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"squad"
]
},
"contextEngineeringPlan": {
"description": "This is the plan for manipulating the message context before handing off the call to the squad.",
"oneOf": [
{
"$ref": "#/components/schemas/ContextEngineeringPlanLastNMessages",
"title": "Last N Messages"
},
{
"$ref": "#/components/schemas/ContextEngineeringPlanNone",
"title": "None"
},
{
"$ref": "#/components/schemas/ContextEngineeringPlanAll",
"title": "All"
}
]
},
"squadId": {
"type": "string",
"description": "This is the squad id to transfer the call to."
},
"squad": {
"description": "This is a transient squad to transfer the call to.",
"allOf": [
{
"$ref": "#/components/schemas/CreateSquadDTO"
}
]
},
"entryAssistantName": {
"type": "string",
"description": "This is the name of the entry assistant to start with when handing off to the squad.\nIf not provided, the first member of the squad will be used."
},
"variableExtractionPlan": {
"description": "This is the variable extraction plan for the handoff tool.",
"allOf": [
{
"$ref": "#/components/schemas/VariableExtractionPlan"
}
]
},
"squadOverrides": {
"description": "These are the overrides to apply to the squad configuration.\nMaps to squad-level membersOverrides.",
"allOf": [
{
"$ref": "#/components/schemas/AssistantOverrides"
}
]
},
"description": {
"type": "string",
"description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
}
},
"required": [
"type"
]
},
"CreateHandoffToolDTO": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -12605,6 +12740,10 @@
{
"$ref": "#/components/schemas/HandoffDestinationDynamic",
"title": "Dynamic"
},
{
"$ref": "#/components/schemas/HandoffDestinationSquad",
"title": "Squad"
}
]
}
Expand Down Expand Up @@ -29695,74 +29834,6 @@
}
}
},
"SquadMemberDTO": {
"type": "object",
"properties": {
"assistantDestinations": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TransferDestinationAssistant",
"title": "Transfer Destination"
},
{
"$ref": "#/components/schemas/HandoffDestinationAssistant",
"title": "Handoff Destination"
}
]
}
},
"assistantId": {
"type": "string",
"nullable": true,
"description": "This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead."
},
"assistant": {
"description": "This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.",
"allOf": [
{
"$ref": "#/components/schemas/CreateAssistantDTO"
}
]
},
"assistantOverrides": {
"description": "This can be used to override the assistant's settings and provide values for it's template variables.",
"allOf": [
{
"$ref": "#/components/schemas/AssistantOverrides"
}
]
}
}
},
"CreateSquadDTO": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This is the name of the squad."
},
"members": {
"description": "This is the list of assistants that make up the squad.\n\nThe call will start with the first assistant in the list.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SquadMemberDTO"
}
},
"membersOverrides": {
"description": "This can be used to override all the assistants' settings and provide values for their template variables.\n\nBoth `membersOverrides` and `members[n].assistantOverrides` can be used together. First, `members[n].assistantOverrides` is applied. Then, `membersOverrides` is applied as a global override.",
"allOf": [
{
"$ref": "#/components/schemas/AssistantOverrides"
}
]
}
},
"required": [
"members"
]
},
"Squad": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -38867,6 +38938,10 @@
{
"$ref": "#/components/schemas/HandoffDestinationDynamic",
"title": "Dynamic"
},
{
"$ref": "#/components/schemas/HandoffDestinationSquad",
"title": "Squad"
}
]
}
Expand Down Expand Up @@ -41312,6 +41387,10 @@
{
"$ref": "#/components/schemas/HandoffDestinationDynamic",
"title": "Dynamic"
},
{
"$ref": "#/components/schemas/HandoffDestinationSquad",
"title": "Squad"
}
]
}
Expand Down Expand Up @@ -59999,12 +60078,8 @@
"type": "object",
"properties": {
"destination": {
"description": "This is the destination you'd like the call to be transferred to.",
"allOf": [
{
"$ref": "#/components/schemas/HandoffDestinationAssistant"
}
]
"type": "object",
"description": "This is the destination you'd like the call to be transferred to."
},
"error": {
"type": "string",
Expand Down