JOjoinanvil
Prompts API

Get metrics data by prompt ID

Changed on

Returns all related metrics data by prompt ID

get/api/beta/prompt

Request

  • Base URL
    http://localhost:58425
  • URL
    http://localhost:58425/api/beta/prompt
  • Auth
    HTTP bearer

Query parameters

promptIdstring required

Response

Successfully retrieved

idstring
createdstring date-time
triggerDatestring date-time
llmProvider'openai/gpt-4o' | 'openai/gpt-4o-search-preview' | 'perplexity' | 'gemini'
promptIdstring
promptTextstring
websiteTopicIdstring
answerTextstring
ownerWebsiteUrlstring
ownerWebsiteIdstring
completePostProcessboolean
language'ENGLISH' | 'SPANISH' | 'PORTUGUESE' | 'HEBREW' | 'GERMAN' | 'ITALIAN' | 'FRENCH' | 'MANDARIN' | 'HINDI' | 'ARABIC' | 'JAPANESE' | 'RUSSIAN'
locale'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'
status'PENDING_BRIGHTDATA' | 'BRIGHTDATA_PROCESSING' | 'OXY_PROCESSING' | 'PROCESSING_ANSWER' | 'POST_PROCESSING' | 'COMPLETED'
provider'BRIGHT_DATA' | 'OXY'
brightDataPromptIndexinteger
oxyJobIdinteger

Changes

  • 911f19f11004Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status