Update API specifications with fern api update (#4147)
Co-authored-by: github-actions <github-actions@github.com>
This commit is contained in:
@@ -2743,79 +2743,6 @@
|
||||
]
|
||||
}
|
||||
},
|
||||
"/v1/prompts/improve": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Prompts"
|
||||
],
|
||||
"summary": "Improve prompt",
|
||||
"description": "Improve a prompt based on a specific use-case",
|
||||
"operationId": "improve_prompt_v1_prompts_improve_post",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "use-case",
|
||||
"in": "query",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"description": "The use-case for prompt improvement",
|
||||
"title": "Use-Case"
|
||||
},
|
||||
"description": "The use-case for prompt improvement"
|
||||
},
|
||||
{
|
||||
"name": "x-api-key",
|
||||
"in": "header",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings.",
|
||||
"title": "X-Api-Key"
|
||||
},
|
||||
"description": "Skyvern API key for authentication. API key can be found at https://app.skyvern.com/settings."
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ImprovePromptRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful Response",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ImprovePromptResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation Error",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/HTTPValidationError"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/v1/run/tasks/login": {
|
||||
"post": {
|
||||
"tags": [
|
||||
@@ -5282,11 +5209,6 @@
|
||||
],
|
||||
"title": "Description"
|
||||
},
|
||||
"order": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"title": "Order"
|
||||
},
|
||||
"is_default": {
|
||||
"type": "boolean",
|
||||
"title": "Is Default",
|
||||
@@ -5294,9 +5216,6 @@
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"order"
|
||||
],
|
||||
"title": "BranchCondition",
|
||||
"description": "Represents a single conditional branch edge within a ConditionalBlock."
|
||||
},
|
||||
@@ -5306,6 +5225,10 @@
|
||||
"type": "string",
|
||||
"title": "Criteria Type"
|
||||
},
|
||||
"expression": {
|
||||
"type": "string",
|
||||
"title": "Expression"
|
||||
},
|
||||
"description": {
|
||||
"anyOf": [
|
||||
{
|
||||
@@ -5320,7 +5243,8 @@
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"criteria_type"
|
||||
"criteria_type",
|
||||
"expression"
|
||||
],
|
||||
"title": "BranchCriteria",
|
||||
"description": "Abstract interface describing how a branch condition should be evaluated."
|
||||
@@ -5908,12 +5832,12 @@
|
||||
"title": "Disable Cache",
|
||||
"default": false
|
||||
},
|
||||
"branches": {
|
||||
"branch_conditions": {
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/BranchCondition"
|
||||
},
|
||||
"type": "array",
|
||||
"title": "Branches"
|
||||
"title": "Branch Conditions"
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
@@ -5922,7 +5846,7 @@
|
||||
"output_parameter"
|
||||
],
|
||||
"title": "ConditionalBlock",
|
||||
"description": "Branching block that selects the next block label based on ordered conditions."
|
||||
"description": "Branching block that selects the next block label based on list-ordered conditions."
|
||||
},
|
||||
"ContextParameter": {
|
||||
"properties": {
|
||||
@@ -8684,6 +8608,67 @@
|
||||
],
|
||||
"title": "ForLoopBlockYAML"
|
||||
},
|
||||
"GeoTarget": {
|
||||
"properties": {
|
||||
"country": {
|
||||
"type": "string",
|
||||
"maxLength": 2,
|
||||
"minLength": 2,
|
||||
"title": "Country",
|
||||
"description": "ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE')",
|
||||
"examples": [
|
||||
"US",
|
||||
"GB",
|
||||
"DE",
|
||||
"FR"
|
||||
]
|
||||
},
|
||||
"subdivision": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"maxLength": 10
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"title": "Subdivision",
|
||||
"description": "ISO 3166-2 subdivision code without country prefix (e.g., 'CA' for California, 'NY' for New York)",
|
||||
"examples": [
|
||||
"CA",
|
||||
"NY",
|
||||
"TX",
|
||||
"ENG"
|
||||
]
|
||||
},
|
||||
"city": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string",
|
||||
"maxLength": 100
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"title": "City",
|
||||
"description": "City name in English from GeoNames (e.g., 'New York', 'Los Angeles', 'London')",
|
||||
"examples": [
|
||||
"New York",
|
||||
"Los Angeles",
|
||||
"London",
|
||||
"Berlin"
|
||||
]
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"country"
|
||||
],
|
||||
"title": "GeoTarget",
|
||||
"description": "Granular geographic targeting for proxy selection.\n\nSupports country, subdivision (state/region), and city level targeting.\nUses ISO 3166-1 alpha-2 for countries, ISO 3166-2 for subdivisions,\nand GeoNames English names for cities.\n\nExamples:\n - {\"country\": \"US\"} - United States (same as RESIDENTIAL)\n - {\"country\": \"US\", \"subdivision\": \"CA\"} - California, US\n - {\"country\": \"US\", \"subdivision\": \"NY\", \"city\": \"New York\"} - New York City\n - {\"country\": \"GB\", \"city\": \"London\"} - London, UK"
|
||||
},
|
||||
"HTTPValidationError": {
|
||||
"properties": {
|
||||
"detail": {
|
||||
@@ -9409,66 +9394,6 @@
|
||||
],
|
||||
"title": "HumanInteractionBlockYAML"
|
||||
},
|
||||
"ImprovePromptRequest": {
|
||||
"properties": {
|
||||
"context": {
|
||||
"anyOf": [
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"title": "Context",
|
||||
"description": "Additional context about the user's needs"
|
||||
},
|
||||
"prompt": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"title": "Prompt",
|
||||
"description": "The original prompt to improve"
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"prompt"
|
||||
],
|
||||
"title": "ImprovePromptRequest"
|
||||
},
|
||||
"ImprovePromptResponse": {
|
||||
"properties": {
|
||||
"error": {
|
||||
"anyOf": [
|
||||
{
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"title": "Error",
|
||||
"description": "Error message if prompt improvement failed"
|
||||
},
|
||||
"improved": {
|
||||
"type": "string",
|
||||
"title": "Improved",
|
||||
"description": "The improved version of the prompt"
|
||||
},
|
||||
"original": {
|
||||
"type": "string",
|
||||
"title": "Original",
|
||||
"description": "The original prompt provided for improvement"
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": [
|
||||
"improved",
|
||||
"original"
|
||||
],
|
||||
"title": "ImprovePromptResponse"
|
||||
},
|
||||
"InputOrSelectContext": {
|
||||
"properties": {
|
||||
"intention": {
|
||||
@@ -12824,11 +12749,19 @@
|
||||
{
|
||||
"$ref": "#/components/schemas/ProxyLocation"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/GeoTarget"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California\n- US-NY: New York\n- US-TX: Texas\n- US-FL: Florida\n- US-WA: Washington\n- NONE: No proxy\n",
|
||||
"title": "Proxy Location",
|
||||
"description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California\n- US-NY: New York\n- US-TX: Texas\n- US-FL: Florida\n- US-WA: Washington\n- NONE: No proxy\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}",
|
||||
"default": "RESIDENTIAL"
|
||||
},
|
||||
"data_extraction_schema": {
|
||||
@@ -15231,10 +15164,18 @@
|
||||
{
|
||||
"$ref": "#/components/schemas/ProxyLocation"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/GeoTarget"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
],
|
||||
"title": "Proxy Location"
|
||||
},
|
||||
"webhook_callback_url": {
|
||||
"anyOf": [
|
||||
@@ -15445,10 +15386,18 @@
|
||||
{
|
||||
"$ref": "#/components/schemas/ProxyLocation"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/GeoTarget"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
],
|
||||
"title": "Proxy Location"
|
||||
},
|
||||
"webhook_callback_url": {
|
||||
"anyOf": [
|
||||
@@ -16569,11 +16518,19 @@
|
||||
{
|
||||
"$ref": "#/components/schemas/ProxyLocation"
|
||||
},
|
||||
{
|
||||
"$ref": "#/components/schemas/GeoTarget"
|
||||
},
|
||||
{
|
||||
"additionalProperties": true,
|
||||
"type": "object"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California\n- US-NY: New York\n- US-TX: Texas\n- US-FL: Florida\n- US-WA: Washington\n- NONE: No proxy\n",
|
||||
"title": "Proxy Location",
|
||||
"description": "\nGeographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.\n\nAvailable geotargeting options:\n- RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.\n- RESIDENTIAL_ES: Spain\n- RESIDENTIAL_IE: Ireland\n- RESIDENTIAL_GB: United Kingdom\n- RESIDENTIAL_IN: India\n- RESIDENTIAL_JP: Japan\n- RESIDENTIAL_FR: France\n- RESIDENTIAL_DE: Germany\n- RESIDENTIAL_NZ: New Zealand\n- RESIDENTIAL_ZA: South Africa\n- RESIDENTIAL_AR: Argentina\n- RESIDENTIAL_AU: Australia\n- RESIDENTIAL_ISP: ISP proxy\n- US-CA: California\n- US-NY: New York\n- US-TX: Texas\n- US-FL: Florida\n- US-WA: Washington\n- NONE: No proxy\n Can also be a GeoTarget object for granular city/state targeting: {\"country\": \"US\", \"subdivision\": \"CA\", \"city\": \"San Francisco\"}",
|
||||
"default": "RESIDENTIAL"
|
||||
},
|
||||
"webhook_url": {
|
||||
|
||||
Reference in New Issue
Block a user