Neynar Documentation

Generate an NFT image

cURL

curl --request POST \
  --url https://api.neynar.com/v2/farcaster/nft/image/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: NEYNAR_API_DOCS' \
  --header 'x-wallet-id: <x-wallet-id>' \
  --data '
{
  "prompt": "<string>",
  "format": "png",
  "height": 1024,
  "high_fidelity": false,
  "source_image_urls": [\
    "<string>"\
  ],
  "width": 1024
}
'

Python

import requests

url = "https://api.neynar.com/v2/farcaster/nft/image/"

payload = {
    "prompt": "<string>",
    "format": "png",
    "height": 1024,
    "high_fidelity": False,
    "source_image_urls": ["<string>"],
    "width": 1024
}
headers = {
    "x-wallet-id": "<x-wallet-id>",
    "x-api-key": "NEYNAR_API_DOCS",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {
    'x-wallet-id': '<x-wallet-id>',
    'x-api-key': 'NEYNAR_API_DOCS',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt: '<string>',
    format: 'png',
    height: 1024,
    high_fidelity: false,
    source_image_urls: ['<string>'],
    width: 1024
  })
};

fetch('https://api.neynar.com/v2/farcaster/nft/image/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.neynar.com/v2/farcaster/nft/image/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompt' => '<string>',
    'format' => 'png',
    'height' => 1024,
    'high_fidelity' => false,
    'source_image_urls' => [
        '<string>'
    ],
    'width' => 1024
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: NEYNAR_API_DOCS",
    "x-wallet-id: <x-wallet-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://api.neynar.com/v2/farcaster/nft/image/"

payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"format\": \"png\",\n  \"height\": 1024,\n  \"high_fidelity\": false,\n  \"source_image_urls\": [\n    \"<string>\"\n  ],\n  \"width\": 1024\}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-wallet-id", "<x-wallet-id>")
    req.Header.Add("x-api-key", "NEYNAR_API_DOCS")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}

Unirest (Java)

HttpResponse<String> response = Unirest.post("https://api.neynar.com/v2/farcaster/nft/image/")
  .header("x-wallet-id", "<x-wallet-id>")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"format\": \"png\",\n  \"height\": 1024,\n  \"high_fidelity\": false,\n  \"source_image_urls\": [\n    \"<string>\"\n  ],\n  \"width\": 1024\}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/farcaster/nft/image/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-wallet-id"] = '<x-wallet-id>'
request["x-api-key"] = 'NEYNAR_API_DOCS'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"<string>\",\n  \"format\": \"png\",\n  \"height\": 1024,\n  \"high_fidelity\": false,\n  \"source_image_urls\": [\n    \"<string>\"\n  ],\n  \"width\": 1024\}"

response = http.request(request)
puts response.read_body

Response Codes

Sample Response

Success response:

{
  "image_url": "<string>"
}

Error response:

{
  "message": "<string>",
  "code": "<string>",
  "property": "<string>",
  "status": 123
}

Parameters

Authorizations

Body