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

# Get prompt

> Read one prompt by its ID to inspect its name and description; returns the prompt.

`prompt(projectReference: String!, id: String!, sourceTargetKind: SourceTargetKind, runtimeTargetKind: RuntimeTargetKind, targetEnvironmentId: ID, targetBranchId: ID): Prompt!`

Requires project.agents.read.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `projectReference` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | |
| `id` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | The id of the definition, from its list. |
| `sourceTargetKind` | [`SourceTargetKind`](https://veryfront.com/docs/cloud/graphql/types/sourcetargetkind) | No | The source to read; default runtimeTargetKind, else project. |
| `runtimeTargetKind` | [`RuntimeTargetKind`](https://veryfront.com/docs/cloud/graphql/types/runtimetargetkind) | No | Used as the source to read when sourceTargetKind is omitted. |
| `targetEnvironmentId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No | Required with the kind environment. |
| `targetBranchId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No | Required with the kind preview\_branch. |

## Response

Returns [`Prompt!`](https://veryfront.com/docs/cloud/graphql/types/prompt). Open the type for its fields and nested types.

| Field | Type |
| - | - |
| `id` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) |
| `name` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `description` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `sourcePath` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) |
| `editMode` | [`SourceEditMode!`](https://veryfront.com/docs/cloud/graphql/types/sourceeditmode) |

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
query Prompt($projectReference: String!, $id: String!, $sourceTargetKind: SourceTargetKind, $runtimeTargetKind: RuntimeTargetKind, $targetEnvironmentId: ID, $targetBranchId: ID) {
  prompt(projectReference: $projectReference, id: $id, sourceTargetKind: $sourceTargetKind, runtimeTargetKind: $runtimeTargetKind, targetEnvironmentId: $targetEnvironmentId, targetBranchId: $targetBranchId) {
    id
    name
    description
    editMode
    sourcePath
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "id": "example"
}
```

<details>
  <summary>Try this query</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Query

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.