Skip to main content
POST
/
v2
/
studio
/
deployment
/
prompt
Prompt a deployment
curl --request POST \
  --url https://api.neynar.com/v2/studio/deployment/prompt \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "fid": 1,
  "name": "<string>",
  "prompt": "<string>",
  "options": {},
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "response": "<any>"
}
The Miniapp Studio API is an allowlisted API and not publicly available. Contact the Neynar team for more information.
This endpoint can take 5 to 10 minutes to return a response. For incremental progress updates as the prompt is processed, use the streaming endpoint instead.

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Body

application/json
​
fid
integer
required

Farcaster ID of the user

Required range: x >= 0
​
name
string
required

Kubernetes deployment name

​
prompt
string
required

Prompt string to send to the deployment

​
options
object

Additional options for the prompt

​
conversation_id
string<uuid>

Optional conversation ID to continue an existing chat. If not provided, a new conversation will be created.

Response

Success

​
conversation_id
string<uuid>
required

The conversation ID for this chat session

​
response
any

Response from the deployment