Retrieve stored prompt

Retrieve a specific stored prompt by ID.

GET /v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/prompts/{id}

Retrieve stored prompt

cURL

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/prompts/{id} \
  --header 'Authorization: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prompt": "<string>",
  "country": "<string>",
  "attribute": "<string>"
}

Authorizations

Authorization · string · header · required

Path Parameters

analysis_id · string<uuid> · required

A UUID string identifying the analysis.

id · string<uuid> · required

A UUID string identifying this user generated content prompts.

organization_id · string<uuid> · required

A UUID string identifying the organization.

workspace_id · string<uuid> · required

A UUID string identifying the workspace.

Response

200

application/json

Details of the stored prompt.

id · string<uuid> · required · read-only

analysis_id · string<uuid> · required

prompt · string · required

Maximum string length: 1000

pipeline · enum<string> · required

• Sources - Sources
• Brand Awareness - Brand Awareness

Available options: Sources, Brand Awareness

country · string

Maximum string length: 255

attribute · string

Maximum string length: 255

intention · enum<string>

• Product Purchase - Product Purchase
• Information Request - Information Request
• Media Retrieval - Media Retrieval

Available options: Product Purchase, Information Request, Media Retrieval,