Neynar Documentation

Create a miniapp generator deployment

cURL

curl --request POST \
  --url https://api.neynar.com/v2/studio/deployment/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: NEYNAR_API_DOCS' \
  --data '
{
  "fid": 3,
  "display_name": "<string>",
  "env": {}
}
'```

### Python Example

```python
import requests

url = "https://api.neynar.com/v2/studio/deployment/"

payload = {
    "fid": 3,
    "display_name": "<string>",
    "env": {}
}
headers = {
    "x-api-key": "NEYNAR_API_DOCS",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript Example

const options = {
  method: 'POST',
  headers: {'x-api-key': 'NEYNAR_API_DOCS', 'Content-Type': 'application/json'},
  body: JSON.stringify({fid: 3, display_name: '<string>', env: {}})
};

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

PHP Example

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.neynar.com/v2/studio/deployment/",
  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([
    'fid' => 3,
    'display_name' => '<string>',
    'env' => []
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: NEYNAR_API_DOCS"
  ],
]);

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

curl_close($curl);

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

Go Example

package main

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

func main() {

url := "https://api.neynar.com/v2/studio/deployment/"

payload := strings.NewReader("{\n  \"fid\": 3,\n  \"display_name\": \"<string>\",\n  \"env\": {}\n}")

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

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) Example

HttpResponse<String> response = Unirest.post("https://api.neynar.com/v2/studio/deployment/")
  .header("x-api-key", "NEYNAR_API_DOCS")
  .header("Content-Type", "application/json")
  .body("{\n  \"fid\": 3,\n  \"display_name\": \"<string>\",\n  \"env\": {}\n}")
  .asString();

Ruby Example

require 'uri'
require 'net/http'

url = URI("https://api.neynar.com/v2/studio/deployment/")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = 'NEYNAR_API_DOCS'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fid\": 3,\n  \"display_name\": \"<string>\",\n  \"env\": {}\n}"

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

Response Structure:

{
  "created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "generated_app_exists": true,
  "generated_app_serving": true,
  "id": "<string>",
  "is_ready": true,
  "name": "<string>",
  "namespace": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "github_url": "<string>",
  "has_database": true,
  "production_app_status": {
    "created_at": 123,
    "deployment_state": "<string>",
    "deployment_url": "<string>",
    "project_id": "<string>",
    "target": "<string>"
  },
  "url": "<string>"
}

Error Response:

{
  "error": "<string>"
}

Note

The Miniapp Studio API is an allowlisted API and not publicly available. Contact the Neynar team for more information.