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

Get Prompt

API Reference
Client
Get metrics by prompt ID
get/api/beta/prompts

Returns all related metrics data by prompt ID

Query Parameters
promptIdstring
Returns
idstring
optional
answerTextstring
optional
brightDataPromptIndexnumber
optional
formatint32
completePostProcessboolean
optional
createdstring
optional
formatdate-time
dataobject
optional
Hide ParametersShow Parameters
importantTermsarray of string
optional
mentionsmap
optional
negativeSentimentarray of map
optional
positiveSentimentsarray of map
optional
rankingmap
optional
sentimentScoremap
optional
sourcesarray of string
optional
languageenum
optional
"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more
Hide ParametersShow Parameters
"ENGLISH"
"SPANISH"
"PORTUGUESE"
"HEBREW"
"GERMAN"
"ITALIAN"
"FRENCH"
"MANDARIN"
"HINDI"
"ARABIC"
"JAPANESE"
"RUSSIAN"
llmProviderenum
optional
"openai/gpt-4o" OR "openai/gpt-4o-search-preview" OR "perplexity" OR "gemini"
Hide ParametersShow Parameters
"openai/gpt-4o"
"openai/gpt-4o-search-preview"
"perplexity"
"gemini"
localeenum
optional
"GLOBAL" OR "ISRAEL" OR "EU" OR 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"
ownerWebsiteIdstring
optional
ownerWebsiteUrlstring
optional
oxyJobIdnumber
optional
formatint64
promptIdstring
optional
promptTextstring
optional
providerenum
optional
"BRIGHT_DATA" OR "OXY"
Hide ParametersShow Parameters
"BRIGHT_DATA"
"OXY"
statusenum
optional
"PENDING_BRIGHTDATA" OR "BRIGHTDATA_PROCESSING" OR "OXY_PROCESSING" OR 3 more
Hide ParametersShow Parameters
"PENDING_BRIGHTDATA"
"BRIGHTDATA_PROCESSING"
"OXY_PROCESSING"
"PROCESSING_ANSWER"
"POST_PROCESSING"
"COMPLETED"
triggerDatestring
optional
formatdate-time
websiteTopicIdstring
optional
curl https://api.joinanvil.com/api/beta/api/beta/prompts \
    -H "Authorization: Bearer $ANVIL_API_KEY" \
    -d '{}'
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"
  }
]