Skip to main content
GET
/
api
/
v1
/
recipes
/
library
/
by-slug
/
{slug}
Get recipe detail by slug
import requests

url = "https://api.example.com/api/v1/recipes/library/by-slug/{slug}"

response = requests.get(url)

print(response.text)
{
  "result": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "title": "<string>",
    "description": "<string>",
    "example_prompts": [
      "<string>"
    ],
    "chains": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "category": [
      "<string>"
    ],
    "icon": "<string>",
    "author_name": "<string>",
    "status": "draft",
    "featured": true,
    "verified": true,
    "view_count": 123,
    "use_count": 123,
    "share_count": 123,
    "search_count": 123,
    "locale": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "content_markdown": "<string>",
    "tokens": {},
    "knowledgehub_doc_id": "<string>",
    "sdk_example_path": "<string>"
  },
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Path Parameters

slug
string
required

Query Parameters

track_view
boolean
default:true

When true (default), increment the recipe's view counter.

Response

Successful Response

result
RecipeDetailRead · object
required
success
boolean
default:true
suggestion
string
default:""
message
string
default:""
meta
PaginationMeta · object

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.