List prompts

prompts(projectReference: String!, sourceTargetKind: SourceTargetKind, runtimeTargetKind: RuntimeTargetKind, targetEnvironmentId: ID, targetBranchId: ID): PromptList!

Requires project.agents.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceString!Yes
sourceTargetKindSourceTargetKindNoThe source to read; default runtimeTargetKind, else project.
runtimeTargetKindRuntimeTargetKindNoUsed as the source to read when sourceTargetKind is omitted.
targetEnvironmentIdIDNoRequired with the kind environment.
targetBranchIdIDNoRequired with the kind preview_branch.

Response

Returns PromptList!. Open the type for its fields and nested types.

FieldTypeDescription
data[Prompt!]!
pageInfoPageInfo!
diagnostics[SourceFileDiagnostic!]!Prompt source files that could not be read as a prompt.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query Prompts($projectReference: String!, $sourceTargetKind: SourceTargetKind, $runtimeTargetKind: RuntimeTargetKind, $targetEnvironmentId: ID, $targetBranchId: ID) {
  prompts(projectReference: $projectReference, sourceTargetKind: $sourceTargetKind, runtimeTargetKind: $runtimeTargetKind, targetEnvironmentId: $targetEnvironmentId, targetBranchId: $targetBranchId) {
    data {
      id
      name
      description
      editMode
      sourcePath
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
    diagnostics {
      code
      details
      kind
      message
      severity
    }
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}