Gooey.AI API Platform

πŸ“– Introduction

You can interact with the API through HTTP requests from any language.

If you're comfortable with OpenAPI specs, jump straight to our complete API

πŸ” Authentication

The Gooey.AI API uses API keys for authentication. Visit the API Keys section to retrieve the API key you'll use in your requests.

Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.

All API requests should include your API key in an Authorization HTTP header as follows:

Authorization: Bearer GOOEY_API_KEY

Copilot for the Enterprise
πŸ“€ 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 = {
  "input_prompt": "Hi"
};

async function gooeyAPI() {
  const response = await fetch("https://api.gooey.ai/v2/video-bots/", {
    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 = {"input_prompt": "Hi"}

response = requests.post(
    "https://api.gooey.ai/v2/video-bots/",
    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/video-bots/ \
  -H "Authorization: Bearer $GOOEY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "input_prompt": "Hi"
}'
🎁 Example Response
{4 Items
"id"
:
string
"wepnbxf6k3js"
"url"
:
string
"https://gooey.ai/copilot/"
"created_at"
:
string
"2024-02-29T19:45:08.582756"
"output"
:
{12 Items
"final_prompt"
:
string
"<|im_start|>system You are Farmer.CHAT - an intell…"
"output_text"
:
[1 Items
0
:
string
"Welcome to Farmer.CHAT. I'm an AI πŸ€– designed to h…"
]
"output_audio"
:
[1 Items
0
:
string
"https://storage.googleapis.com/dara-c1b52.appspot.…"
]
"output_video"
:
[
]0 Items
"raw_input_text"
:
string
"Hi"
"raw_tts_text"
:
NULL
"raw_output_text"
:
[1 Items
0
:
string
"Welcome to Farmer.CHAT. I'm an AI πŸ€– designed to h…"
]
"references"
:
[2 Items
0
:
{
…
}6 Items
1
:
{
…
}6 Items
]
"final_search_query"
:
string
"Hi!"
"final_keyword_query"
:
NULL
"output_documents"
:
NULL
"reply_buttons"
:
NULL
}
}

πŸ” API keys

Please Login to generate the $GOOEY_API_KEY