Skip to content
Anvil Docs
  • Auto
  • Light
  • Dark
Get Started

Get Prompt

API Reference
Client
Get metrics by prompt ID
get_prompt(ClientGetPromptParams**kwargs) -> idstranswer_textstrbright_data_prompt_indexintcomplete_post_processboolcreateddatetimedataGetPromptResponseItemDatalanguageliteralllm_providerliterallocaleliteralowner_website_idstrowner_website_urlstroxy_job_idintprompt_idstrprompt_textstrproviderliteralstatusliteraltrigger_datedatetimewebsite_topic_idstrGetPromptResponse
get/api/beta/prompts

Returns all related metrics data by prompt ID

Parameters
prompt_idstr
Returns
GetPromptResponsetype
List[GetPromptResponseItem]
Hide ParametersShow Parameters
idstr
optional
answer_textstr
optional
bright_data_prompt_indexint
optional
formatint32
complete_post_processbool
optional
createddatetime
optional
formatdate-time
dataimportant_termslistmentionsDict[str, int]negative_sentimentlistpositive_sentimentslistrankingDict[str, int]sentiment_scoreDict[str, int]sourceslistGetPromptResponseItemData
optional
Hide ParametersShow Parameters
important_termslist
optional
Optional[List[str]]
mentionsDict[str, int]
optional
Optional[Dict[str, int]]
negative_sentimentlist
optional
Optional[List[Dict[str, str]]]
positive_sentimentslist
optional
Optional[List[Dict[str, str]]]
rankingDict[str, int]
optional
Optional[Dict[str, int]]
sentiment_scoreDict[str, int]
optional
Optional[Dict[str, int]]
sourceslist
optional
Optional[List[str]]
languageliteral
optional
Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
llm_providerliteral
optional
Optional[Literal["openai/gpt-4o", "openai/gpt-4o-search-preview", "perplexity", "gemini"]]
Hide ParametersShow Parameters
"openai/gpt-4o"
"openai/gpt-4o-search-preview"
"perplexity"
"gemini"
localeliteral
optional
Optional[Literal["GLOBAL", "ISRAEL", "EU", 97 more]]
Hide ParametersShow Parameters
"GLOBAL"
"ISRAEL"
"EU"
"UK"
"US"
"IL"
"AL"
"AZ"
"KG"
"BA"
"UZ"
"BI"
"XK"
"SM"
"DE"
"AT"
"CH"
"IE"
"IM"
"FR"
"ES"
"NL"
"IT"
"PT"
"BE"
"AD"
"MT"
"MC"
"MA"
"LU"
"TN"
"DZ"
"GI"
"LI"
"SE"
"DK"
"FI"
"NO"
"AX"
"IS"
"GG"
"JE"
"GL"
"VA"
"FX"
"FO"
"AF"
"AM"
"AU"
"BH"
"BD"
"BT"
"BN"
"KH"
"CN"
"CY"
"GE"
"HK"
"IN"
"ID"
"IR"
"IQ"
"JP"
"JO"
"KZ"
"KW"
"LA"
"LB"
"MY"
"MV"
"MN"
"MM"
"NP"
"OM"
"PK"
"PH"
"QA"
"SA"
"SG"
"KR"
"LK"
"SY"
"TW"
"TH"
"TR"
"AE"
"VN"
"YE"
"AR"
"BO"
"BR"
"CL"
"CO"
"EC"
"GY"
"PY"
"PE"
"SR"
"UY"
"VE"
owner_website_idstr
optional
owner_website_urlstr
optional
oxy_job_idint
optional
formatint64
prompt_idstr
optional
prompt_textstr
optional
providerliteral
optional
Optional[Literal["BRIGHT_DATA", "OXY"]]
Hide ParametersShow Parameters
"BRIGHT_DATA"
"OXY"
statusliteral
optional
Optional[Literal["PENDING_BRIGHTDATA", "BRIGHTDATA_PROCESSING", "OXY_PROCESSING", 3 more]]
Hide ParametersShow Parameters
"PENDING_BRIGHTDATA"
"BRIGHTDATA_PROCESSING"
"OXY_PROCESSING"
"PROCESSING_ANSWER"
"POST_PROCESSING"
"COMPLETED"
trigger_datedatetime
optional
formatdate-time
website_topic_idstr
optional
from anvil import Anvil

client = Anvil(
    api_key="My API Key",
)
response = client.get_prompt(
    prompt_id="promptId",
)
print(response)
200 Example
[
  {
    "id": "id",
    "answerText": "answerText",
    "brightDataPromptIndex": 0,
    "completePostProcess": true,
    "created": "2019-12-27T18:11:19.117Z",
    "data": {
      "importantTerms": [
        "string"
      ],
      "mentions": {
        "foo": 0
      },
      "negativeSentiment": [
        {
          "foo": "string"
        }
      ],
      "positiveSentiments": [
        {
          "foo": "string"
        }
      ],
      "ranking": {
        "foo": 0
      },
      "sentimentScore": {
        "foo": 0
      },
      "sources": [
        "string"
      ]
    },
    "language": "ENGLISH",
    "llmProvider": "openai/gpt-4o",
    "locale": "GLOBAL",
    "ownerWebsiteId": "ownerWebsiteId",
    "ownerWebsiteUrl": "ownerWebsiteUrl",
    "oxyJobId": 0,
    "promptId": "promptId",
    "promptText": "promptText",
    "provider": "BRIGHT_DATA",
    "status": "PENDING_BRIGHTDATA",
    "triggerDate": "2019-12-27T18:11:19.117Z",
    "websiteTopicId": "websiteTopicId"
  }
]