> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neynar.com/llms.txt
> Use this file to discover all available pages before exploring further.

# promptDeployment

# promptDeployment

Prompt a deployment

> **Group:** Studio APIs

Use this when you need: **Prompt a deployment**.

## Usage

```ts theme={"system"}
import { NeynarAPIClient, Configuration } from "@neynar/nodejs-sdk";

const client = new NeynarAPIClient(
  new Configuration({ apiKey: "YOUR_NEYNAR_API_KEY" })
);

const res = await client.promptDeployment({
  promptDeploymentRequest: "value", // required
});
console.log(res);
```

## Parameters

| Parameter                 | Type                      | Required | Description |
| ------------------------- | ------------------------- | :------: | ----------- |
| `promptDeploymentRequest` | `PromptDeploymentRequest` |     ✅    | -           |

## Response

Returns a `RequestArgs` object.

## Error Handling

```ts theme={"system"}
try {
  const res = await client.promptDeployment({ /* required fields */ });
  // use res
} catch (err) {
  // Axios/HTTP errors, invalid params, auth issues, etc.
  console.error(err);
}
```

## Tips

* Provide a **viewerFid** when supported to respect mutes/blocks and include `viewer_context`.
* Keep requests scoped (e.g., use `limit`) to improve latency.
* Cache results where sensible.


## Related topics

- [promptDeploymentStream](/nodejs-sdk/studio-apis/promptDeploymentStream.md)
- [Prompt deployment](/reference/prompt-deployment.md)
- [Prompt a deployment with streaming response](/reference/prompt-deployment-stream.md)
- [Create and Manage Miniapp Studio Deployments](/docs/studio-api-miniapp-management.md)
- [Deployments](/farcaster/reference/contracts/deployments.md)