Skymith Open API 1.0.0¶

Skymith Open API allows for effortless research on any topic.

Research¶

The research features are divided into two modes: speed and quality.

Speed vs Quality¶

Mode	Time	Output	Use Case
Speed	Around 12 seconds	Final response + References + Keywords	Day-to-
day questions and real-time applications.
Quality	Around 1.5 minutes	Final response + References + Keywords + Up to
5 Complete Sub-Queries Answered	Complex questions, in-depth research, and non-
real-time applications (e.g., news).

Finance-Specific Endpoints¶

Skymith Open API was born from GPTStonks, so we include the most relevant finance-related endpoints used in GPTStonks. They take only a few seconds to respond, as the answers are cached.

Contact: Skymith hello@Skymith.com

agents¶

GET /service/agents/research¶

Get Research

Asynchronous endpoint for fast intelligent web surfing.

Args:

query (str): user query to research and answer.
timelimit (str): how old are the posts retrieved from the Internet. One of d, w, m, y. Defaults to one week old.

Input parameters

Parameter	In	Type	Nullable
`OAuth2PasswordBearer`	header	string	No
`query`	query	string	No
`timelimit`	query	string	No

Responses

200 Successful Response

application/json

{
    "type": "string",
    "body": "string",
    "follow_up_questions": null,
    "references": null,
    "intermediate_steps": null,
    "keywords": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "type": {
            "type": "string",
            "title": "Type"
        },
        "body": {
            "type": "string",
            "title": "Body"
        },
        "follow_up_questions": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Follow Up Questions"
        },
        "references": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "References"
        },
        "intermediate_steps": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Intermediate Steps"
        },
        "keywords": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Keywords"
        }
    },
    "type": "object",
    "required": [
        "type",
        "body"
    ],
    "title": "BaseAgentResponse",
    "description": "Model to define the base response parameters."
}

422 Validation Error

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

finance_recommender¶

GET /recommend/me/concept¶

Recommend Me Financial Concept

Explain financial concepts to users.

The concept is updated every day. The concept is retrieved in the language of your account, but it is faster in English (i.e., without any token).

Input parameters

Parameter	In	Type	Nullable	Description
`token`	query	None	No

Responses

200 Successful Response

application/json

{
    "content_presented": "string",
    "follow_up_questions": null,
    "references": null,
    "intermediate_steps": null,
    "keywords": [
        "string"
    ],
    "title": "string",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "unique_id": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "content_presented": {
            "type": "string",
            "title": "Content Presented",
            "description": "content sent to the final user"
        },
        "follow_up_questions": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Follow Up Questions"
        },
        "references": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "References"
        },
        "intermediate_steps": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Intermediate Steps"
        },
        "keywords": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "title": "Keywords",
            "description": "securities mentioned in the response",
            "default": []
        },
        "title": {
            "type": "string",
            "title": "Title",
            "description": "title of the content"
        },
        "timestamp": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp",
            "description": "when the content presented was ingested into Mongo"
        },
        "unique_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Unique Id",
            "description": "unique identifier for the conversation, if any"
        }
    },
    "type": "object",
    "required": [
        "content_presented",
        "title",
        "timestamp"
    ],
    "title": "ContentPresentedOut",
    "description": "Model to send an educational concept."
}

422 Validation Error

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /recommend/open/news¶

Recommend Open News Article

Provide a detailed explanation of the most relevant news of the day.

Updated twice per day. The concept is retrieved in the language of your account, but it is faster in English (i.e., without any token).

Input parameters

Parameter	In	Type	Nullable	Description
`token`	query	None	No
`unique_id`	query	None	No

Responses

200 Successful Response

application/json

{
    "content_presented": "string",
    "follow_up_questions": null,
    "references": null,
    "intermediate_steps": null,
    "keywords": [
        "string"
    ],
    "title": "string",
    "timestamp": "2022-04-13T15:42:05.901Z",
    "unique_id": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "content_presented": {
            "type": "string",
            "title": "Content Presented",
            "description": "content sent to the final user"
        },
        "follow_up_questions": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Follow Up Questions"
        },
        "references": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "References"
        },
        "intermediate_steps": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Intermediate Steps"
        },
        "keywords": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "title": "Keywords",
            "description": "securities mentioned in the response",
            "default": []
        },
        "title": {
            "type": "string",
            "title": "Title",
            "description": "title of the content"
        },
        "timestamp": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp",
            "description": "when the content presented was ingested into Mongo"
        },
        "unique_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Unique Id",
            "description": "unique identifier for the conversation, if any"
        }
    },
    "type": "object",
    "required": [
        "content_presented",
        "title",
        "timestamp"
    ],
    "title": "ContentPresentedOut",
    "description": "Model to send an educational concept."
}

422 Validation Error

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /recommend/open/titles/all¶

Recover Open News Ids

Return all the titles of the news of the past 7 days, with their UUIDs.

Max. 100 news.

Input parameters

Parameter	In	Type	Nullable	Description
`timedelta_days`	query	integer	No
`token`	query	None	No

Responses

200 Successful Response

application/json

[
    {
        "unique_id": "5df30454-75e1-4415-9999-d7b7c857af74",
        "title": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/EnumerationContentPresentedOut"
    },
    "title": "Response Recover Open News Ids Recommend Open Titles All Get"
}

422 Validation Error

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /recommend/query/widgets¶

Recommend Query Widgets

Recommend TradingView widgets based on the given query.

Args:

query_in (str): text to retrieve the widgets with. E.g., news about Google will retrieve news widgets and possibly some related to Google stock price.

Input parameters

Parameter	In	Type	Nullable	Description
`OAuth2PasswordBearer`	header	string	No

Request body

application/json

{
    "query": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "query": {
            "type": "string",
            "title": "Query"
        }
    },
    "additionalProperties": false,
    "type": "object",
    "required": [
        "query"
    ],
    "title": "QueryIn"
}

Responses

200 Successful Response

application/json

[
    null
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "items": {
        "$ref": "#/components/schemas/RootModel_Union_TechnicalAnalysisTVWidget__TopStoriesTVWidget__FundamentalAnalysisTVWidget__ScreenerTVWidget__StockMarketTVWidget__BaseTVWidget__"
    },
    "type": "array",
    "title": "RootModel[list[RootModel[Union[TechnicalAnalysisTVWidget, TopStoriesTVWidget, FundamentalAnalysisTVWidget, ScreenerTVWidget, StockMarketTVWidget, BaseTVWidget]]]]"
}

422 Validation Error

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas¶

BaseAgentResponse¶

Name	Type
`body`	string
`follow_up_questions`
`intermediate_steps`
`keywords`
`references`
`type`	string

BaseTVWidget¶

Name	Type
`name`	string

ContentPresentedOut¶

Name	Type
`content_presented`	string
`follow_up_questions`
`intermediate_steps`
`keywords`	Array<string>
`references`
`timestamp`	string(date-time)
`title`	string
`unique_id`

EnumerationContentPresentedOut¶

Name	Type
`title`	string
`unique_id`	string(uuid)

FundamentalAnalysisTVWidget¶

Name	Type
`name`	string
`symbol`	string

HTTPValidationError¶

Name	Type
`detail`	Array<Schema(ValidationError)>

QueryIn¶

Name	Type
`query`	string

RootModel_list_RootModel_Union_TechnicalAnalysisTVWidgetTopStoriesTVWidgetFundamentalAnalysisTVWidgetScreenerTVWidgetStockMarketTVWidgetBaseTVWidget__¶

Type: Array<Schema(RootModel_Union_TechnicalAnalysisTVWidget__TopStoriesTVWidget__FundamentalAnalysisTVWidget__ScreenerTVWidget__StockMarketTVWidget__BaseTVWidget__)>

RootModel_Union_TechnicalAnalysisTVWidgetTopStoriesTVWidgetFundamentalAnalysisTVWidgetScreenerTVWidgetStockMarketTVWidgetBaseTVWidget¶

Type:

ScreenerTVWidget¶

Name	Type
`market`	string
`name`	string

StockMarketTVWidget¶

Name	Type
`exchange`	string
`name`	string

TechnicalAnalysisTVWidget¶

Name	Type
`interval`	string
`name`	string
`symbol`	string

TopStoriesTVWidget¶

Name	Type
`feedMode`	string
`market`
`name`	string
`symbol`

ValidationError¶

Name	Type
`loc`	Array<>
`msg`	string
`type`	string

Security schemes¶

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2

Skymith Open API 1.0.0¶

Research¶

Speed vs Quality¶

Finance-Specific Endpoints¶

agents¶

GET /service/agents/research¶

Input parameters

Responses

finance_recommender¶

GET /recommend/me/concept¶

Input parameters

Responses

GET /recommend/open/news¶

Input parameters

Responses

GET /recommend/open/titles/all¶

Input parameters

Responses

POST /recommend/query/widgets¶

Input parameters

Responses

Schemas¶

BaseAgentResponse¶

BaseTVWidget¶

ContentPresentedOut¶

EnumerationContentPresentedOut¶

FundamentalAnalysisTVWidget¶

HTTPValidationError¶

QueryIn¶

RootModel_list_RootModel_Union_TechnicalAnalysisTVWidget__TopStoriesTVWidget__FundamentalAnalysisTVWidget__ScreenerTVWidget__StockMarketTVWidget__BaseTVWidget____¶

RootModel_Union_TechnicalAnalysisTVWidget__TopStoriesTVWidget__FundamentalAnalysisTVWidget__ScreenerTVWidget__StockMarketTVWidget__BaseTVWidget__¶

ScreenerTVWidget¶

StockMarketTVWidget¶

TechnicalAnalysisTVWidget¶

TopStoriesTVWidget¶

ValidationError¶

Security schemes¶

RootModel_list_RootModel_Union_TechnicalAnalysisTVWidgetTopStoriesTVWidgetFundamentalAnalysisTVWidgetScreenerTVWidgetStockMarketTVWidgetBaseTVWidget__¶

RootModel_Union_TechnicalAnalysisTVWidgetTopStoriesTVWidgetFundamentalAnalysisTVWidgetScreenerTVWidgetStockMarketTVWidgetBaseTVWidget¶