Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neynar studio API

The studio API from Neynar — 32 operation(s) for studio.

This API exposes 39 operations across 32 paths, and defines 2 schemas. It is described by OpenAPI 3.0.4, at version 3.176.0.

Requests are made against a single base URL, https://api.neynar.com.

39 operations 32 paths 2 schemas 3 DELETE16 GET1 PATCH18 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.4
API Version
3.176.0
Base URL
https://api.neynar.com
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Neynar studio API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key to authorize requests

Paths & Operations 39

Across 32 paths, the API surfaces 39 operations — 3 DELETE, 16 GET, 1 PATCH, 18 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

studio 39
GET
/v2/studio/credit-drops/
Get most recent credit drop
get-credit-drop 1 param → 200402404
POST
/v2/studio/credit-drops/claim
Claim credit drop
claim-credit-drop body → 200402404409410
DELETE
/v2/studio/deployment/
Delete deployment(s)
delete-deployment body → 200400404500
GET
/v2/studio/deployment/
List deployments
list-deployments 6 params → 200400403500
POST
/v2/studio/deployment/
Create a miniapp generator deployment
create-deployment body → 200400500
GET
/v2/studio/deployment/account-association
Get account association of a miniapp
get-account-association 3 params → 200400404500
POST
/v2/studio/deployment/account-association
Set account association
associate-deployment body → 200400404500
POST
/v2/studio/deployment/build
Build generated app with automatic error fixing
build body → 200400404409500
GET
/v2/studio/deployment/by-name-and-fid
Get deployment info
get-deployment 4 params → 200400404500
GET
/v2/studio/deployment/conversations
List conversations for a deployment
list-conversations 4 params → 200400403404500
GET
/v2/studio/deployment/conversations/messages
Get messages in a conversation
get-conversation-messages 8 params → 200400403404500
POST
/v2/studio/deployment/database/provision
Provision a database for a deployment
provision body → 200400403404500
POST
/v2/studio/deployment/database/query
Query table data
query-table body → 200400403404500
POST
/v2/studio/deployment/database/sql
Execute raw SQL query (admin only)
execute-sql body → 200400403404500
GET
/v2/studio/deployment/database/tables
List all tables in deployment database
list-tables 2 params → 200400403404500
DELETE
/v2/studio/deployment/database/tables/{table_name}/rows
Delete rows from table
delete-rows 1 param body → 200400403404500
PATCH
/v2/studio/deployment/database/tables/{table_name}/rows
Update rows in table
update-rows 1 param body → 200400403404500
POST
/v2/studio/deployment/database/tables/{table_name}/rows
Insert rows into table
insert-rows 1 param body → 200400403404500
GET
/v2/studio/deployment/database/tables/{table_name}/schema
Get table schema
get-table-schema 3 params → 200400403404500
GET
/v2/studio/deployment/dev-status
Get dev status of a miniapp
get-dev-status 3 params → 200400404500
GET
/v2/studio/deployment/export-zip
Export deployment source code as ZIP
export-zip 4 params → 200400402403404500
GET
/v2/studio/deployment/file
Get deployment file contents
get-deployment-file 5 params → 200400403404500
GET
/v2/studio/deployment/files
List deployment files
list-deployment-files 5 params → 200400403404500
POST
/v2/studio/deployment/prompt/stream
Prompt a deployment with streaming response
prompt-deployment-stream body → 200202400404413500
POST
/v2/studio/deployment/recover
Recover dev server with two-phase strategy
recover body → 200400404409500
DELETE
/v2/studio/deployment/secrets/
Delete deployment secrets
delete-secrets body → 200400404500
GET
/v2/studio/deployment/secrets/
List deployment secrets
list-secrets 2 params → 200404500
POST
/v2/studio/deployment/secrets/
Upsert deployment secrets
upsert-secrets body → 200400404500
POST
/v2/studio/deployment/session/cancel
Cancel an active Claude session for a deployment
cancel-session body → 200400404500
POST
/v2/studio/deployment/start
Start generated miniapp
start-app body → 200400403404408500
POST
/v2/studio/deployment/stop
Stop generated miniapp
stop-app body → 200400403404500
POST
/v2/studio/deployment/upload-image
Upload image to deployment
upload-image → 200400404500
POST
/v2/studio/deployment/upload-image-url
Upload image from URL to deployment
upload-image-url body → 200400404500
POST
/v2/studio/usage/report
Report studio compute unit usage
report-studio-usage body → 200400401404500
POST
/v2/studio/vercel/
Deploy miniapp to Vercel
deploy-to-vercel body → 200400404409500
PUT
/v2/studio/vercel/domain
Assign a custom subdomain to a deployed miniapp
assign-custom-domain 1 param body → 200400403404409500
GET
/v2/studio/vercel/domain/check
Check if a custom subdomain is available
check-domain-availability 2 params → 200400500
GET
/v2/studio/vercel/logs
Get Vercel deployment build logs
vercel-deployment-logs 5 params → 200400403404500
GET
/v2/studio/vercel/status
Get Vercel deployment status
vercel-deployment-status 4 params → 200400404500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ErrorRes (4 properties), NextCursor (1 property). Each schema is shown below with its type and property counts.

NextCursor
object
Returns next cursor
1 property 1 required
ErrorRes
object
Details for the error response
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neynar-studio-api-openapi.yml Raw ↑