Kuvasta Tekstiksi API-dokumentaatio (V2)

Johdanto ja Käyttötapaukset

Kuvasta Tekstiksi API mahdollistaa tekoälypohjaisten kuvankuvausominaisuuksien integroinnin sovelluksiisi. API:mme käyttää kehittyneitä tekoälymalleja kuvien analysointiin ja yksityiskohtaisten kuvausten luomiseen.

Yleiset Käyttötapaukset

Yksityiskohtaisten kuvausten luominen kuville
Tekstin ja tiedon poimiminen kuvista
Kuvan sisällön ja kontekstin analysointi
Hahmojen kuvausten luominen luovaan kirjoittamiseen
Kuvatekstien luominen sisällönhallintaan

API-avaimet

Käyttääksesi API:amme tarvitset API-tunnukset (API-avain ja Salaisuus). Voit hallita API-avaimiasi hallintapaneelissa.

Hallitse API-avaimia →

API-päätepiste

POST https://imagedescriber.online/api/openapi-v2/describe-image

Integraatio-opas

Pyyntöotsikot

Otsikon Nimi	Pakollinen	Kuvaus
content-type	Kyllä	Täytyy olla multipart/form-data
authorization	Kyllä	Täytyy olla Bearer ${SECRET_KEY} ${SECRET_KEY} on API-avaimesi.

Pyyntöparametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
image	string tai file	Kyllä	Kuva kuvauksen luomista varten. Hyväksyy kolme syöttömuotoa: 1. Kuvan URL, alkaa http:// tai https:// 2. Base64-koodattu kuva, muodossa: data:image/jpeg;base64,/9j/4AAQSkZJR... (Huom: muut kuvatyypit kuten PNG ovat myös mahdollisia, säädä mime-type vastaavasti) 3. Tiedosto-objekti: Tiedosto-objekti, joka edustaa mallikuvaa.
prompt	string	Kyllä	Mukautettu kehote kuvan analysointia varten
lang	string	Ei	Vastauksen kieli (en/zh/de/es/fr/ja/ko/fi/nl/pt/tr/ru), oletus: en

Vastausmuoto

Kenttä	Tyyppi	Kuvaus
code	number	Vastauksen tilakoodi. 200 onnistumiselle
data	object	Vastauksen data-objekti, läsnä kun code on 200
data.content	string	Luotu kuvaus kuvalle
msg	string	Vastausviesti, tarjoaa lisätietoja
succeed	boolean	Ilmaisee, onnistuiko pyyntö

Esimerkki Vastaus

{
    "code": 200,
    "data": {
        "content": "Yksityiskohtainen kuvaus kuvasta markdown-muodossa..."
    },
    "succeed": true,
    "msg": "Onnistui"
}

Virhekoodit

Koodi	Viesti	Kuvaus
200	OK	Pyyntö onnistui
500	SERVER_ERROR	Sisäinen palvelinvirhe
10003	INSUFFICIENT_CREDITS	Riittämättömät krediitit
10004	INVALID_PARAM	Virheelliset parametrit
10005	HARMFUL_CONTENT	Haitallista sisältöä havaittu
30001	INVALID_API_KEY	Virheellinen API-avain
30002	INVALID_SIGNATURE	Virheellinen pyynnön allekirjoitus

Koodiesimerkit

Curl-esimerkki Kuvan URL:lla

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image="https://persistent.imagedescriber.online/image-describer-examples/000.jpg"' \
--form 'prompt="Kuvaile lyhyesti kuvan sisältö"' \
--form 'lang="fi"'

Curl-esimerkki Paikallisella Kuvatiedostolla

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image=@"/PATH/TO/YOUR/IMAGE.jpg"' \
--form 'prompt="Kuvaile lyhyesti kuvan sisältö"' \
--form 'lang="fi"'

Curl-esimerkki Base64-kuvalla

curl --location 'https://imagedescriber.online/api/openapi-v2/describe-image' \
--header 'Authorization: Bearer ${SECRET_KEY}' \
--form 'image="data:image/jpeg;base64,/9j……/9k="' \
--form 'prompt="Kuvaile lyhyesti kuvan sisältö"' \
--form 'lang="fi"'

Node.js-esimerkki

async function callDescribeImageApi() {
  const apiKey = 'YOUR_API_KEY'; // Korvaa todellisella API-avaimellasi

  const formData = new FormData();
  formData.append('image', ...); // Tukee url:ää, kuvatiedostoa, base64-koodattua kuvaa
  formData.append('prompt', 'Kuvaile lyhyesti kuvan sisältö');
  formData.append('lang', 'fi'); // Vastauskielen koodi

  const apiEndpoint = 'https://imagedescriber.online/api/openapi-v2/describe-image';
  try {
    const response = await fetch(apiEndpoint, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${apiKey}`,
      },
      body: formData,
    });

    if (!response.ok) {
      const errorData = await response.json();
      throw new Error(`HTTP error ${response.status}: ${errorData.msg || 'Tuntematon virhe'}`);
    }

    const data = await response.json();
    return { content: data.data.content, error: null };

  } catch (error) {
    console.error('Virhe kuvan kuvailussa:', error);
    return { content: null, error: error.message };
  }
}

Python-esimerkki

import requests
import base64

async def call_describe_image_api():
    api_key = 'YOUR_API_KEY'  # Korvaa todellisella API-avaimellasi

    form_data = {
        'image': 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...',  # Esimerkki Base64-kuva. Korvaa todellisilla kuvatiedoillasi. Tukee url:ää, tiedostoa ja base64:ää.
        'prompt': 'Kuvaile lyhyesti kuvan sisältö',
        'lang': 'fi' # Vastauskielen koodi
    }

    api_endpoint = 'https://imagedescriber.online/api/openapi-v2/describe-image'
    try:
        headers = {
            'Authorization': f'Bearer {api_key}',
        }

        response = requests.post(api_endpoint, files=form_data, headers=headers) # Käytä files= multipart/form-datalle
        response.raise_for_status()  # Nostaa poikkeuksen virhetilakoodeille (4xx tai 5xx)

        data = response.json()
        return {'content': data.get('data', {}).get('content'), 'error': None}

    except requests.exceptions.RequestException as e:
        print(f'Virhe kuvan kuvailussa: {e}')
        return {'content': None, 'error': str(e)}

Hinnoittelu

API-kutsut kuluttavat tilisi krediittejä. Voit ostaa krediittejä hinnoittelusivultamme.

Katso Hinnat →

Ohje ja Tuki

Jos sinulla on kysyttävää tai tarvitset apua, älä epäröi ottaa yhteyttä tukitiimiimme.

Sähköposti: [email protected]