وثائق مطابقة للمنصة.

مسار قصير لأول استدعاء. عينات OpenAPI توضيحية.

اطلب الوصول المبكر أدناه للانضمام إلى قائمة الإعداد ومفاتيح API.

البدء

اطلب الوصول المبكر

أخبرنا بما تبنيه. نراجع الطلبات ونراسلك عند الفتح.

اشترِ حزمة توكن

من 29$ / 200 ألف توكن. رصيد واحد لكل الوحدات.

استدعِ الواجهات

صادِق وأنفق عبر التجارة والبث والذكاء الاصطناعي والاجتماعي وأكثر.

عينات OpenAPI

مسارات /v1/sample وهمية للشكل فقط.

GET/v1/sample/recipes/{id}

Catalog item by id

{
  "id": "rec_sample_8f3a2c",
  "slug": "lemon-herb-salmon-bowl",
  "title": "Lemon Herb Salmon Bowl",
  "description": "Seared salmon with quinoa, roasted vegetables, and a citrus yogurt sauce.",
  "cuisine": "mediterranean",
  "dietTags": [
    "pescatarian",
    "gluten-free"
  ],
  "servings": 2,
  "prepTimeMinutes": 15,
  "cookTimeMinutes": 20,
  "nutritionPerServing": {
    "calories": 520,
    "proteinGrams": 38,
    "carbsGrams": 42,
    "fatGrams": 22
  },
  "ingredients": [
    {
      "name": "salmon fillet",
      "quantity": 300,
      "unit": "g",
      "notes": "skin-on preferred"
    },
    {
      "name": "quinoa",
      "quantity": 120,
      "unit": "g",
      "notes": "dry"
    },
    {
      "name": "zucchini",
      "quantity": 1,
      "unit": "piece"
    },
    {
      "name": "lemon",
      "quantity": 1,
      "unit": "piece"
    },
    {
      "name": "greek yogurt",
      "quantity": 80,
      "unit": "g"
    }
  ],
  "steps": [
    "Rinse quinoa and cook according to package directions.",
    "Season salmon with salt, pepper, and lemon zest; sear 3–4 minutes per side.",
    "Roast zucchini until tender; plate with quinoa and yogurt sauce."
  ],
  "media": {
    "heroImageUrl": "https://cdn.example.invalid/sample/salmon-bowl.jpg"
  },
  "meta": {
    "illustrative": true,
    "path": "/v1/sample/recipes/{id}",
    "note": "Fictional sample payload for docs only"
  }
}

GET/v1/sample/recipes

Catalog search

{
  "query": {
    "q": "salmon bowl",
    "cuisine": "mediterranean",
    "diet": "pescatarian",
    "maxCookTimeMinutes": 30
  },
  "page": 1,
  "pageSize": 10,
  "total": 2,
  "results": [
    {
      "id": "rec_sample_8f3a2c",
      "title": "Lemon Herb Salmon Bowl",
      "cuisine": "mediterranean",
      "dietTags": [
        "pescatarian",
        "gluten-free"
      ],
      "cookTimeMinutes": 20,
      "score": 0.94
    },
    {
      "id": "rec_sample_1b9e77",
      "title": "Mediterranean Chickpea Power Bowl",
      "cuisine": "mediterranean",
      "dietTags": [
        "vegetarian"
      ],
      "cookTimeMinutes": 25,
      "score": 0.71
    }
  ],
  "meta": {
    "illustrative": true,
    "path": "/v1/sample/recipes",
    "note": "Fictional sample payload for docs only"
  }
}

POST/v1/sample/meal-plans

Create shared plan

{
  "id": "plan_sample_c4d91e",
  "name": "Weeknight Mediterranean",
  "startDate": "2026-07-20",
  "endDate": "2026-07-24",
  "status": "draft",
  "householdServings": 2,
  "days": [
    {
      "date": "2026-07-20",
      "meals": [
        {
          "slot": "breakfast",
          "recipeId": "rec_sample_a11",
          "title": "Yogurt Parfait with Berries"
        },
        {
          "slot": "lunch",
          "recipeId": "rec_sample_b22",
          "title": "Chickpea Salad Wrap"
        },
        {
          "slot": "dinner",
          "recipeId": "rec_sample_8f3a2c",
          "title": "Lemon Herb Salmon Bowl"
        }
      ]
    },
    {
      "date": "2026-07-21",
      "meals": [
        {
          "slot": "breakfast",
          "recipeId": "rec_sample_a12",
          "title": "Shakshuka for Two"
        },
        {
          "slot": "lunch",
          "recipeId": "rec_sample_b23",
          "title": "Herb Farro Bowl"
        },
        {
          "slot": "dinner",
          "recipeId": "rec_sample_c33",
          "title": "Baked Cod with Tomatoes"
        }
      ]
    }
  ],
  "groceryListId": "groc_sample_91af",
  "meta": {
    "illustrative": true,
    "path": "/v1/sample/meal-plans",
    "note": "Fictional meal planning API example for docs only"
  }
}

POST/v1/sample/marketplace/checkout

Marketplace checkout

{
  "orderId": "ord_sample_9c41",
  "status": "paid",
  "total": 86.4,
  "currency": "USD",
  "lineItems": [
    {
      "listingId": "lst_sample_a1",
      "quantity": 1,
      "unitPrice": 49
    },
    {
      "listingId": "lst_sample_b2",
      "quantity": 2,
      "unitPrice": 12.5
    }
  ],
  "meta": {
    "illustrative": true,
    "path": "/v1/sample/marketplace/checkout",
    "note": "Fictional marketplace checkout sample for docs only"
  }
}

POST/v1/sample/live/sessions

Create live session

{
  "sessionId": "live_sample_44d0",
  "status": "ready",
  "joinUrl": "https://example.invalid/live/live_sample_44d0",
  "chatEnabled": true,
  "meta": {
    "illustrative": true,
    "path": "/v1/sample/live/sessions",
    "note": "Fictional live session sample for docs only"
  }
}

GET/v1/sample/grocery-lists/{planId}

Shared list

{
  "id": "groc_sample_91af",
  "planId": "plan_sample_c4d91e",
  "currency": "EUR",
  "estimatedTotal": 48.25,
  "items": [
    {
      "name": "salmon fillet",
      "quantity": 600,
      "unit": "g",
      "aisle": "seafood",
      "recipeIds": [
        "rec_sample_8f3a2c"
      ]
    },
    {
      "name": "quinoa",
      "quantity": 240,
      "unit": "g",
      "aisle": "grains",
      "recipeIds": [
        "rec_sample_8f3a2c",
        "rec_sample_b23"
      ]
    },
    {
      "name": "greek yogurt",
      "quantity": 500,
      "unit": "g",
      "aisle": "dairy",
      "recipeIds": [
        "rec_sample_a11",
        "rec_sample_8f3a2c"
      ]
    },
    {
      "name": "cherry tomatoes",
      "quantity": 400,
      "unit": "g",
      "aisle": "produce",
      "recipeIds": [
        "rec_sample_c33"
      ]
    },
    {
      "name": "lemon",
      "quantity": 3,
      "unit": "piece",
      "aisle": "produce",
      "recipeIds": [
        "rec_sample_8f3a2c"
      ]
    }
  ],
  "meta": {
    "illustrative": true,
    "path": "/v1/sample/grocery-lists/{planId}",
    "note": "Fictional sample payload for docs only"
  }
}

عرض التسعير

البدء

اطلب الوصول المبكر

أخبرنا بما تبنيه. نراجع الطلبات ونراسلك عند الفتح.

اشترِ حزمة توكن

من 29$ / 200 ألف توكن. رصيد واحد لكل الوحدات.

استدعِ الواجهات

صادِق وأنفق عبر التجارة والبث والذكاء الاصطناعي والاجتماعي وأكثر.

{ "id": "rec_sample_8f3a2c", "slug": "lemon-herb-salmon-bowl", "title": "Lemon Herb Salmon Bowl", "description": "Seared salmon with quinoa, roasted vegetables, and a citrus yogurt sauce.", "cuisine": "mediterranean", "dietTags": [ "pescatarian", "gluten-free" ], "servings": 2, "prepTimeMinutes": 15, "cookTimeMinutes": 20, "nutritionPerServing": { "calories": 520, "proteinGrams": 38, "carbsGrams": 42, "fatGrams": 22 }, "ingredients": [ { "name": "salmon fillet", "quantity": 300, "unit": "g", "notes": "skin-on preferred" }, { "name": "quinoa", "quantity": 120, "unit": "g", "notes": "dry" }, { "name": "zucchini", "quantity": 1, "unit": "piece" }, { "name": "lemon", "quantity": 1, "unit": "piece" }, { "name": "greek yogurt", "quantity": 80, "unit": "g" } ], "steps": [ "Rinse quinoa and cook according to package directions.", "Season salmon with salt, pepper, and lemon zest; sear 3–4 minutes per side.", "Roast zucchini until tender; plate with quinoa and yogurt sauce." ], "media": { "heroImageUrl": "https://cdn.example.invalid/sample/salmon-bowl.jpg" }, "meta": { "illustrative": true, "path": "/v1/sample/recipes/{id}", "note": "Fictional sample payload for docs only" } }

{ "query": { "q": "salmon bowl", "cuisine": "mediterranean", "diet": "pescatarian", "maxCookTimeMinutes": 30 }, "page": 1, "pageSize": 10, "total": 2, "results": [ { "id": "rec_sample_8f3a2c", "title": "Lemon Herb Salmon Bowl", "cuisine": "mediterranean", "dietTags": [ "pescatarian", "gluten-free" ], "cookTimeMinutes": 20, "score": 0.94 }, { "id": "rec_sample_1b9e77", "title": "Mediterranean Chickpea Power Bowl", "cuisine": "mediterranean", "dietTags": [ "vegetarian" ], "cookTimeMinutes": 25, "score": 0.71 } ], "meta": { "illustrative": true, "path": "/v1/sample/recipes", "note": "Fictional sample payload for docs only" } }

{ "id": "plan_sample_c4d91e", "name": "Weeknight Mediterranean", "startDate": "2026-07-20", "endDate": "2026-07-24", "status": "draft", "householdServings": 2, "days": [ { "date": "2026-07-20", "meals": [ { "slot": "breakfast", "recipeId": "rec_sample_a11", "title": "Yogurt Parfait with Berries" }, { "slot": "lunch", "recipeId": "rec_sample_b22", "title": "Chickpea Salad Wrap" }, { "slot": "dinner", "recipeId": "rec_sample_8f3a2c", "title": "Lemon Herb Salmon Bowl" } ] }, { "date": "2026-07-21", "meals": [ { "slot": "breakfast", "recipeId": "rec_sample_a12", "title": "Shakshuka for Two" }, { "slot": "lunch", "recipeId": "rec_sample_b23", "title": "Herb Farro Bowl" }, { "slot": "dinner", "recipeId": "rec_sample_c33", "title": "Baked Cod with Tomatoes" } ] } ], "groceryListId": "groc_sample_91af", "meta": { "illustrative": true, "path": "/v1/sample/meal-plans", "note": "Fictional meal planning API example for docs only" } }

{ "orderId": "ord_sample_9c41", "status": "paid", "total": 86.4, "currency": "USD", "lineItems": [ { "listingId": "lst_sample_a1", "quantity": 1, "unitPrice": 49 }, { "listingId": "lst_sample_b2", "quantity": 2, "unitPrice": 12.5 } ], "meta": { "illustrative": true, "path": "/v1/sample/marketplace/checkout", "note": "Fictional marketplace checkout sample for docs only" } }

{ "sessionId": "live_sample_44d0", "status": "ready", "joinUrl": "https://example.invalid/live/live_sample_44d0", "chatEnabled": true, "meta": { "illustrative": true, "path": "/v1/sample/live/sessions", "note": "Fictional live session sample for docs only" } }

{ "id": "groc_sample_91af", "planId": "plan_sample_c4d91e", "currency": "EUR", "estimatedTotal": 48.25, "items": [ { "name": "salmon fillet", "quantity": 600, "unit": "g", "aisle": "seafood", "recipeIds": [ "rec_sample_8f3a2c" ] }, { "name": "quinoa", "quantity": 240, "unit": "g", "aisle": "grains", "recipeIds": [ "rec_sample_8f3a2c", "rec_sample_b23" ] }, { "name": "greek yogurt", "quantity": 500, "unit": "g", "aisle": "dairy", "recipeIds": [ "rec_sample_a11", "rec_sample_8f3a2c" ] }, { "name": "cherry tomatoes", "quantity": 400, "unit": "g", "aisle": "produce", "recipeIds": [ "rec_sample_c33" ] }, { "name": "lemon", "quantity": 3, "unit": "piece", "aisle": "produce", "recipeIds": [ "rec_sample_8f3a2c" ] } ], "meta": { "illustrative": true, "path": "/v1/sample/grocery-lists/{planId}", "note": "Fictional sample payload for docs only" } }