Skip to content

Latest commit

 

History

History
161 lines (117 loc) · 4.93 KB

getting-started.md

File metadata and controls

161 lines (117 loc) · 4.93 KB
Raw
description
You can interact with our APIs through node.js, python or curl

Getting started

CREATE AN API KEY

Gooey.AI allows single API key for several workflows. So whether you are including AI images in your app or making a highly customized AI Copilot, you can access our whole suite of workflows through a single API key.

CREATE API KEYS HERE:

{% embed url="https://gooey.ai/api/#api-keys" %}

You can click on "Create new secret key"

A new API KEY will appear

Copy the key and use it for your API Requests.

{% hint style="info" %} Make sure you don't share your API KEY with anyone! 🚫 {% endhint %}

AUTHENTICATION

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

MAKING A REQUEST

Let's make an example request to the lipsyncTTS API

{% tabs %} {% tab title="node.js" %}

Step 1

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 init
$ npm install node-fetch
$ export GOOEY_API_KEY=sk-xxxx

Step 2

Use this sample code to call the API. Make sure to include the full code snippet and the error message.

import fetch from 'node-fetch';

const payload = {
  "input_face": "https://storage.googleapis.com/dara-c1b52.appspot.com/daras_ai/media/6ce4c720-a799-11ed-9033-02420a0001d8/NEW%20LONG%20VID.mp4",
  "text_prompt": "Add your text prompt for Lipsync TTS here"
};

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

{% endtab %}

{% tab title="python" %}

Step 1

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

Step 2

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_face": "https://storage.googleapis.com/dara-c1b52.appspot.com/daras_ai/media/6ce4c720-a799-11ed-9033-02420a0001d8/NEW%20LONG%20VID.mp4",
    "text_prompt": "Add your text prompt for Lipsync TTS here",
}

response = requests.post(
    "https://api.gooey.ai/v2/LipsyncTTS/",
    headers={
        "Authorization": "Bearer " + os.environ["GOOEY_API_KEY"],
    },
    json=payload,
)
assert response.ok, response.content

result = response.json()
print(response.status_code, result)

{% endtab %}

{% tab title="curl" %}

Step 1

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

Step 2

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/LipsyncTTS/ \
  -H "Authorization: Bearer $GOOEY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "input_face": "https://storage.googleapis.com/dara-c1b52.appspot.com/daras_ai/media/6ce4c720-a799-11ed-9033-02420a0001d8/NEW%20LONG%20VID.mp4",
  "text_prompt": "Add your text prompt for Lipsync TTS here"
}'

{% endtab %} {% endtabs %}

This is what the example response will look like:

{
  "id": "aghpjaxi",
  "url": "https://gooey.ai/lipsync-maker/?run_id=aghpjaxi&uid=fm165fOmucZlpa5YHupPBdcvDR02",
  "created_at": "2023-05-16T13:48:08.093970+00:00",
  "output": {
    "output_video": "https://storage.googleapis.com/dara-c1b52.appspot.com/daras_ai/media/27b18b98-9a96-11ee-a030-02420a0001ca/gooey.ai%20lipsync.mp4"
  }
}