Skip to content

GET /v1/prompts/publish

Summary

Search the catalogue of published prompts by keyword. Results are ranked by relevance using a combination of text similarity and semantic matching. Video prompts are excluded from results.

HTTP Request

http
GET /v1/prompts/publish?q=<query>

Query parameters

ParameterTypeRequiredDescription
qstringYesSearch query. Maximum 200 characters; leading/trailing whitespace is trimmed.

Response

Success (200 OK)

Returns a JSON object whose status is "SUCCESS" and a data object containing:

FieldTypeDescription
rowsarray of objectsList of matching prompts, ranked by relevance.
rows[].promptIdstringIdentifier of the published prompt.
rows[].promptVersionIdstringIdentifier of the latest published version.
rows[].titlestringTitle of the prompt.
rows[].descriptionstringShort description of the prompt.
rows[].slugstringURL-friendly slug for the prompt.
rows[].modelintegerModel index used by the prompt. See Models & Options.
rows[].modalityinteger0 for text, 1 for image.
rows[].estimatedCreditsintegerEstimated credit cost per run.
rows[].usesintegerTotal number of times the prompt has been run.
rows[].upVotesintegerNumber of upvotes.
rows[].publishedAtstring (ISO 8601)When the latest version was published.
rows[].samplesobjectSample inputs/outputs for the prompt.
rows[].configsobjectPrompt configuration metadata.

Example response

json
{
  "status": "SUCCESS",
  "data": {
    "rows": [
      {
        "promptId": "01234567-89ab-cdef-0123-456789abcdef",
        "promptVersionId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "title": "Blog post writer",
        "description": "Generate a blog post from a topic and tone.",
        "slug": "blog-post-writer",
        "model": 50,
        "modality": 0,
        "estimatedCredits": 150,
        "uses": 2340,
        "upVotes": 187,
        "publishedAt": "2025-11-03T10:15:30.000Z",
        "samples": {},
        "configs": {}
      }
    ]
  }
}

Error responses

HTTP statusstatus codeDescription
422VALIDATION_ERRORMissing or invalid q parameter.

See also