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

โš• API Generator

Choose a workflow to see how you can interact with it via the API

Copilot Builder

๐Ÿ“ค 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": "When should I plant chili?"
};

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": "When should I plant chili?"}

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": "When should I plant chili?"
}'
๐ŸŽ Example Response
{4 Items
"id"
:
string
"efdrsrb10z8x"
"url"
:
string
"https://gooey.ai/copilot/"
"created_at"
:
string
"2024-05-20T22:32:26.310767"
"output"
:
{13 Items
"final_prompt"
:
[2 Items
0
:
{
โ€ฆ
}2 Items
1
:
{
โ€ฆ
}2 Items
]
"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
"When should I plant chili?"
"raw_tts_text"
:
NULL
"raw_output_text"
:
[1 Items
0
:
string
"Welcome to Farmer.CHAT. I'm an AI ๐Ÿค– designed to hโ€ฆ"
]
"references"
:
[3 Items
0
:
{
โ€ฆ
}4 Items
1
:
{
โ€ฆ
}4 Items
2
:
{
โ€ฆ
}4 Items
]
"final_search_query"
:
string
"You should plant chili when the conditions are suiโ€ฆ"
"final_keyword_query"
:
NULL
"output_documents"
:
NULL
"reply_buttons"
:
NULL
"finish_reason"
:
NULL
}
}

๐Ÿ” API keys

Please Login to generate the $GOOEY_API_KEY