Skip to content

Update API specifications with fern api update #874

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 #874

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
244 changes: 142 additions & 102 deletions fern/apis/api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7769,6 +7769,7 @@
{
"enum": [
"scribe_v1",
"scribe_v2",
"scribe_v2_realtime"
]
}
Expand Down Expand Up @@ -9627,6 +9628,7 @@
{
"enum": [
"scribe_v1",
"scribe_v2",
"scribe_v2_realtime"
]
}
Expand Down Expand Up @@ -18124,6 +18126,89 @@
}
}
},
"ComplianceOverride": {
"type": "object",
"properties": {
"forceStoreOnHipaaEnabled": {
"type": "boolean",
"description": "Force storage for this output under HIPAA. Only enable if output contains no sensitive data.",
"example": false
}
}
},
"CreateStructuredOutputDTO": {
"type": "object",
"properties": {
"model": {
"description": "This is the model that will be used to extract the structured output.\n\nTo provide your own custom system and user prompts for structured output extraction, populate the messages array with your system and user messages. You can specify liquid templating in your system and user messages.\nBetween the system or user messages, you must reference either 'transcript' or 'messages' with the '{{}}' syntax to access the conversation history.\nBetween the system or user messages, you must reference a variation of the structured output with the '{{}}' syntax to access the structured output definition.\ni.e.:\n{{structuredOutput}}\n{{structuredOutput.name}}\n{{structuredOutput.description}}\n{{structuredOutput.schema}}\n\nIf model is not specified, GPT-4.1 will be used by default for extraction, utilizing default system and user prompts.\nIf messages or required fields are not specified, the default system and user prompts will be used.",
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowOpenAIModel",
"title": "WorkflowOpenAIModel"
},
{
"$ref": "#/components/schemas/WorkflowAnthropicModel",
"title": "WorkflowAnthropicModel"
},
{
"$ref": "#/components/schemas/WorkflowGoogleModel",
"title": "WorkflowGoogleModel"
},
{
"$ref": "#/components/schemas/WorkflowCustomModel",
"title": "WorkflowCustomModel"
}
]
},
"compliancePlan": {
"description": "Compliance configuration for this output. Only enable overrides if no sensitive data will be stored.",
"example": {
"forceStoreOnHipaaEnabled": false
},
"allOf": [
{
"$ref": "#/components/schemas/ComplianceOverride"
}
]
},
"name": {
"type": "string",
"description": "This is the name of the structured output.",
"minLength": 1,
"maxLength": 40
},
"schema": {
"description": "This is the JSON Schema definition for the structured output.\n\nThis is required when creating a structured output. Defines the structure and validation rules for the data that will be extracted. Supports all JSON Schema features including:\n- Objects and nested properties\n- Arrays and array validation\n- String, number, boolean, and null types\n- Enums and const values\n- Validation constraints (min/max, patterns, etc.)\n- Composition with allOf, anyOf, oneOf",
"allOf": [
{
"$ref": "#/components/schemas/JsonSchema"
}
]
},
"description": {
"type": "string",
"description": "This is the description of what the structured output extracts.\n\nUse this to provide context about what data will be extracted and how it will be used."
},
"assistantIds": {
"description": "These are the assistant IDs that this structured output is linked to.\n\nWhen linked to assistants, this structured output will be available for extraction during those assistant's calls.",
"type": "array",
"items": {
"type": "string"
}
},
"workflowIds": {
"description": "These are the workflow IDs that this structured output is linked to.\n\nWhen linked to workflows, this structured output will be available for extraction during those workflow's execution.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"schema"
]
},
"ScorecardMetric": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -18251,6 +18336,13 @@
"type": "string"
}
},
"structuredOutputs": {
"description": "This is an array of transient structured outputs to be calculated during the call.\nThe outputs will be extracted and stored in `call.artifact.structuredOutputs` after the call is ended.\nUse this to provide inline structured output configurations instead of referencing existing ones via structuredOutputIds.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateStructuredOutputDTO"
}
},
"scorecardIds": {
"description": "This is an array of scorecard IDs that will be evaluated based on the structured outputs extracted during the call.\nThe scorecards will be evaluated and the results will be stored in `call.artifact.scorecards` after the call has ended.",
"type": "array",
Expand Down Expand Up @@ -35627,6 +35719,14 @@
}
]
},
"assistantOverrides": {
"description": "These are the overrides for the assistant configuration.\nUse this to provide variable values and other overrides when using assistantId.\nVariable substitution will be applied to the assistant's messages and other text-based fields.",
"allOf": [
{
"$ref": "#/components/schemas/AssistantOverrides"
}
]
},
"squadId": {
"type": "string",
"description": "This is the squad ID associated with this session. Use this when referencing an existing squad."
Expand Down Expand Up @@ -35738,6 +35838,14 @@
}
]
},
"assistantOverrides": {
"description": "These are the overrides for the assistant configuration.\nUse this to provide variable values and other overrides when using assistantId.\nVariable substitution will be applied to the assistant's messages and other text-based fields.",
"allOf": [
{
"$ref": "#/components/schemas/AssistantOverrides"
}
]
},
"squadId": {
"type": "string",
"description": "This is the squad ID associated with this session. Use this when referencing an existing squad."
Expand Down Expand Up @@ -41753,16 +41861,6 @@
"providerId"
]
},
"ComplianceOverride": {
"type": "object",
"properties": {
"forceStoreOnHipaaEnabled": {
"type": "boolean",
"description": "Force storage for this output under HIPAA. Only enable if output contains no sensitive data.",
"example": false
}
}
},
"StructuredOutput": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -41876,79 +41974,6 @@
"metadata"
]
},
"CreateStructuredOutputDTO": {
"type": "object",
"properties": {
"model": {
"description": "This is the model that will be used to extract the structured output.\n\nTo provide your own custom system and user prompts for structured output extraction, populate the messages array with your system and user messages. You can specify liquid templating in your system and user messages.\nBetween the system or user messages, you must reference either 'transcript' or 'messages' with the '{{}}' syntax to access the conversation history.\nBetween the system or user messages, you must reference a variation of the structured output with the '{{}}' syntax to access the structured output definition.\ni.e.:\n{{structuredOutput}}\n{{structuredOutput.name}}\n{{structuredOutput.description}}\n{{structuredOutput.schema}}\n\nIf model is not specified, GPT-4.1 will be used by default for extraction, utilizing default system and user prompts.\nIf messages or required fields are not specified, the default system and user prompts will be used.",
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowOpenAIModel",
"title": "WorkflowOpenAIModel"
},
{
"$ref": "#/components/schemas/WorkflowAnthropicModel",
"title": "WorkflowAnthropicModel"
},
{
"$ref": "#/components/schemas/WorkflowGoogleModel",
"title": "WorkflowGoogleModel"
},
{
"$ref": "#/components/schemas/WorkflowCustomModel",
"title": "WorkflowCustomModel"
}
]
},
"compliancePlan": {
"description": "Compliance configuration for this output. Only enable overrides if no sensitive data will be stored.",
"example": {
"forceStoreOnHipaaEnabled": false
},
"allOf": [
{
"$ref": "#/components/schemas/ComplianceOverride"
}
]
},
"name": {
"type": "string",
"description": "This is the name of the structured output.",
"minLength": 1,
"maxLength": 40
},
"schema": {
"description": "This is the JSON Schema definition for the structured output.\n\nThis is required when creating a structured output. Defines the structure and validation rules for the data that will be extracted. Supports all JSON Schema features including:\n- Objects and nested properties\n- Arrays and array validation\n- String, number, boolean, and null types\n- Enums and const values\n- Validation constraints (min/max, patterns, etc.)\n- Composition with allOf, anyOf, oneOf",
"allOf": [
{
"$ref": "#/components/schemas/JsonSchema"
}
]
},
"description": {
"type": "string",
"description": "This is the description of what the structured output extracts.\n\nUse this to provide context about what data will be extracted and how it will be used."
},
"assistantIds": {
"description": "These are the assistant IDs that this structured output is linked to.\n\nWhen linked to assistants, this structured output will be available for extraction during those assistant's calls.",
"type": "array",
"items": {
"type": "string"
}
},
"workflowIds": {
"description": "These are the workflow IDs that this structured output is linked to.\n\nWhen linked to workflows, this structured output will be available for extraction during those workflow's execution.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"schema"
]
},
"UpdateStructuredOutputDTO": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -44239,7 +44264,9 @@
"in",
"not_in",
"contains",
"not_contains"
"not_contains",
"is_empty",
"is_not_empty"
]
},
"value": {
Expand Down Expand Up @@ -44279,7 +44306,9 @@
"example": "\"in\" or \"not_in\"",
"enum": [
"in",
"not_in"
"not_in",
"is_empty",
"is_not_empty"
]
},
"value": {
Expand Down Expand Up @@ -44319,7 +44348,9 @@
"example": "\"in\" or \"not_in\"",
"enum": [
"in",
"not_in"
"not_in",
"is_empty",
"is_not_empty"
]
},
"value": {
Expand Down Expand Up @@ -46383,6 +46414,10 @@
"type": "number",
"description": "This is the total number of calls made since evaluationStartAt to determine percentage of calls affected."
},
"callsCount": {
"type": "number",
"description": "This is the count of calls that triggered this issue.\nThis is populated in list responses as a summary count."
},
"evaluationStartAt": {
"format": "date-time",
"type": "string",
Expand All @@ -46395,6 +46430,11 @@
"$ref": "#/components/schemas/IssueCall"
}
},
"lastSeenAt": {
"format": "date-time",
"type": "string",
"description": "This is the ISO 8601 date-time string of when the issue was last seen (most recent failed call).\nThis is populated in list responses from the MAX(failed_at) in issue_call table."
},
"status": {
"type": "string",
"description": "This is the status of the issue.",
Expand All @@ -46409,24 +46449,16 @@
"description": "This is the email/name of the user who acknowledged the issue.",
"maxLength": 255
},
"resolvedBy": {
"type": "string",
"description": "This is the email/name of the user who resolved the issue.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "This is the unique identifier for the issue."
},
"orgId": {
"type": "string",
"description": "This is the unique identifier for the org that this issue belongs to."
},
"acknowledgedAt": {
"format": "date-time",
"type": "string",
"description": "This is the ISO 8601 date-time string of when the issue was acknowledged."
},
"resolvedBy": {
"type": "string",
"description": "This is the email/name of the user who resolved the issue.",
"maxLength": 255
},
"resolvedAt": {
"format": "date-time",
"type": "string",
Expand All @@ -46441,6 +46473,14 @@
"format": "date-time",
"type": "string",
"description": "This is the ISO 8601 date-time string of when the issue was last updated."
},
"id": {
"type": "string",
"description": "This is the unique identifier for the issue."
},
"orgId": {
"type": "string",
"description": "This is the unique identifier for the org that this issue belongs to."
}
},
"required": [
Expand All @@ -46449,10 +46489,10 @@
"totalCalls",
"evaluationStartAt",
"status",
"id",
"orgId",
"createdAt",
"updatedAt"
"updatedAt",
"id",
"orgId"
]
},
"UpdateIssueDTO": {
Expand Down