ForVoyezlogo ForVoyez

Quick Start

Welcome to the quick start guide for the ForVoyez API. In this section, we'll walk you through the process of signing up for an account, obtaining your API key, and making your first API call to generate metadata for an image.

Signing Up and Creating an Account

To get started with the ForVoyez API, you'll need to create an account. Follow these steps:

  1. Visit the ForVoyez website and click on the "Sign Up" button.
  2. Fill out the registration form with your email address and a strong password.
  3. Verify your email address by clicking on the confirmation link sent to your inbox.
  4. Once your email is verified, log in to your account.

You can also sign up using your Google or GitHub account for a quicker registration process.

Obtaining the API Key

After logging in to your account, you'll need to obtain your API key. Here's how:

  1. Navigate to the API Settings page in your account dashboard.
  2. Click on the "Add token" button.
  3. Copy your API key and store it in a secure location. You'll need this key to authenticate your requests to the ForVoyez API.
  4. Be careful, the key is only displayed once, so make sure to save it securely.

Learn more about authentication

Making Your First API Call

Now that you have your API key, you're ready to make your first API call to generate metadata for an image. Below are examples using cURL and JavaScript:

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "image=@/path/to/your/image.jpg" \
  -F "schema={\"title\":\"string\",\"alternativeText\":\"string\",\"caption\":\"string\"}" \
  -F "keywords=image,description" \
  -F "context=Your image context" \
  -F "language=en" \
  https://forvoyez.com/api/describe

Make sure to replace YOUR_API_KEY with your actual API key and /path/to/your/image.jpg with the path to the image file you want to generate metadata for.

The request includes the following parameters:

  • image (required): The image file you want to generate metadata for.
  • schema (optional): A JSON string specifying the desired output format for the generated metadata.
  • keywords (optional): A comma-separated list of keywords to help guide the metadata generation.
  • context (optional): Additional context about the image to improve accuracy.
  • language (optional): The desired language for the metadata output (defaults to 'en' for English).

The API will process your request and return a JSON response containing the generated metadata based on your specified schema and language.

Learn more about using the API

Next Steps

Congratulations! You've successfully signed up for an account, obtained your API key, and made your first API call to generate image metadata.

Next, explore the documentation further to learn more about:

  • Authentication: How to authenticate your requests and manage your API keys.
  • Using the API: Details on request formats, parameters, and error handling.
  • Data Schemas: Customizing and validating the metadata output schema.

If you have any questions or need assistance, please don't hesitate to reach out to our support team.