• Gooey.AI
  • API: Automatically create Structured SEO JSON+LD for any Webpage


    📖 To learn more, take a look at our complete API

    📤 Example Request

    1. Generate an api key below👇

    2. Install node-fetch & add the GOOEY_API_KEY to your environment variables.
      Never store the api key in your code and don't use direcly in the browser.

    $ npm install node-fetch
    $ export GOOEY_API_KEY=sk-xxxx
    
    1. Use this sample code to call the API.
      If you encounter any issues, write to us at [email protected] and make sure to include the full code snippet and the error message.
    import fetch from 'node-fetch';
    
    const payload = {
      "documents": [
        "https://gameofthrones.fandom.com/wiki/Jon_Snow"
      ],
      "task_instructions": "Create a LD+JSON summary based on schema.org of the above webpage. \n",
      "merge_instructions": ""
    };
    
    async function gooeyAPI() {
      const response = await fetch("https://api.gooey.ai/v2/doc-summary?example_id=dn4m155n", {
        method: "POST",
        headers: {
          "Authorization": "bearer " + process.env["GOOEY_API_KEY"],
          "Content-Type": "application/json",
        },
        body: JSON.stringify(payload),
      });
    
      if (!response.ok) {
        throw new Error(response.status);
      }
    
      const result = await response.json();
      console.log(response.status, result);
    }
    
    gooeyAPI();
    
    1. Generate an api key below👇

    2. Install requests & add the GOOEY_API_KEY to your environment variables.
      Never store the api key in your code.

    $ python3 -m pip install requests
    $ export GOOEY_API_KEY=sk-xxxx
    
    1. Use this sample code to call the API.
      If you encounter any issues, write to us at [email protected] and make sure to include the full code snippet and the error message.
    import os
    import requests
    
    payload = {
        "documents": ["https://gameofthrones.fandom.com/wiki/Jon_Snow"],
        "task_instructions": "Create a LD+JSON summary based on schema.org of the above webpage. \n",
        "merge_instructions": "",
    }
    
    response = requests.post(
        "https://api.gooey.ai/v2/doc-summary?example_id=dn4m155n",
        headers={
            "Authorization": "bearer " + os.environ["GOOEY_API_KEY"],
        },
        json=payload,
    )
    assert response.ok, response.content
    
    result = response.json()
    print(response.status_code, result)
    
    1. Generate an api key below👇

    2. Install curl & add the GOOEY_API_KEY to your environment variables.
      Never store the api key in your code.

    export GOOEY_API_KEY=sk-xxxx
    
    1. Run the following curl command in your terminal.
      If you encounter any issues, write to us at [email protected] and make sure to include the full curl command and the error message.
    curl 'https://api.gooey.ai/v2/doc-summary?example_id=dn4m155n' \
      -H "Authorization: bearer $GOOEY_API_KEY" \
      -H 'Content-Type: application/json' \
      -d '{
      "documents": [
        "https://gameofthrones.fandom.com/wiki/Jon_Snow"
      ],
      "task_instructions": "Create a LD+JSON summary based on schema.org of the above webpage. \n",
      "merge_instructions": ""
    }'
    

    🎁 Example Response

    {4 Items
    "id"
    :
    string
    "pmnxo84uzyke"
    "url"
    :
    string
    "https://gooey.ai/doc-summary/"
    "created_at"
    :
    string
    "2024-01-23T16:09:28.004050+00:00"
    "output"
    :
    {3 Items
    "output_text"
    :
    [1 Items
    0
    :
    string
    "Based on the provided documents, here is a respons"
    ]
    "prompt_tree"
    :
    [1 Items
    0
    :
    {
    }2 Items
    ]
    "final_prompt"
    :
    string
    "[Document 1]: """ Based on the provided documents,"
    }
    }

    Please Login to generate the $GOOEY_API_KEY