## ListPrompts

`agents.list_prompts(AgentListPromptsParams**kwargs)  -> SyncPromptsPage[Prompt]`

**post** `/gitpod.v1.AgentService/ListPrompts`

Lists all prompts matching the specified criteria.

Use this method to find and browse prompts across your organization.
Results are ordered by their creation time with the newest first.

### Examples

- List all prompts:

  Retrieves all prompts with pagination.

  ```yaml
  pagination:
    pageSize: 10
  ```

### Parameters

- `token: Optional[str]`

- `page_size: Optional[int]`

- `filter: Optional[Filter]`

  - `command: Optional[str]`

  - `command_prefix: Optional[str]`

  - `exclude_prompt_content: Optional[bool]`

    exclude_prompt_content omits the large spec.prompt text from the response.
    Other spec fields (is_template, is_command, command, is_skill) are still returned.
    Use GetPrompt to retrieve the full prompt content when needed.

  - `is_command: Optional[bool]`

  - `is_skill: Optional[bool]`

  - `is_template: Optional[bool]`

  - `search: Optional[str]`

    search performs case-insensitive search across prompt name, description, and command.

- `pagination: Optional[Pagination]`

  - `token: Optional[str]`

    Token for the next set of results that was returned as next_token of a
    PaginationResponse

  - `page_size: Optional[int]`

    Page size is the maximum number of results to retrieve per page.
    Defaults to 25. Maximum 100.

### Returns

- `class Prompt: …`

  - `id: Optional[str]`

  - `metadata: Optional[PromptMetadata]`

    - `created_at: Optional[datetime]`

      A Timestamp represents a point in time independent of any time zone or local
      calendar, encoded as a count of seconds and fractions of seconds at
      nanosecond resolution. The count is relative to an epoch at UTC midnight on
      January 1, 1970, in the proleptic Gregorian calendar which extends the
      Gregorian calendar backwards to year one.

      All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
      second table is needed for interpretation, using a [24-hour linear
      smear](https://developers.google.com/time/smear).

      The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
      restricting to that range, we ensure that we can convert to and from [RFC
      3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

      # Examples

      Example 1: Compute Timestamp from POSIX `time()`.

      Timestamp timestamp;
      timestamp.set_seconds(time(NULL));
      timestamp.set_nanos(0);

      Example 2: Compute Timestamp from POSIX `gettimeofday()`.

      struct timeval tv;
      gettimeofday(&tv, NULL);

      Timestamp timestamp;
      timestamp.set_seconds(tv.tv_sec);
      timestamp.set_nanos(tv.tv_usec * 1000);

      Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.

      FILETIME ft;
      GetSystemTimeAsFileTime(&ft);
      UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

      // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
      // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
      Timestamp timestamp;
      timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
      timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

      Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.

      long millis = System.currentTimeMillis();

      Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
      .setNanos((int) ((millis % 1000) * 1000000)).build();

      Example 5: Compute Timestamp from Java `Instant.now()`.

      Instant now = Instant.now();

      Timestamp timestamp =
      Timestamp.newBuilder().setSeconds(now.getEpochSecond())
      .setNanos(now.getNano()).build();

      Example 6: Compute Timestamp from current time in Python.

      timestamp = Timestamp()
      timestamp.GetCurrentTime()

      # JSON Mapping

      In JSON format, the Timestamp type is encoded as a string in the
      [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
      format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
      where {year} is always expressed using four digits while {month}, {day},
      {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
      seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
      are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
      is required. A proto3 JSON serializer should always use UTC (as indicated by
      "Z") when printing the Timestamp type and a proto3 JSON parser should be
      able to accept both UTC and other timezones (as indicated by an offset).

      For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
      01:30 UTC on January 15, 2017.

      In JavaScript, one can convert a Date object to this format using the
      standard
      [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
      method. In Python, a standard `datetime.datetime` object can be converted
      to this format using
      [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
      the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
      the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format.

    - `creator: Optional[Subject]`

      creator is the identity of the prompt creator

      - `id: Optional[str]`

        id is the UUID of the subject

      - `principal: Optional[Principal]`

        Principal is the principal of the subject

        - `"PRINCIPAL_UNSPECIFIED"`

        - `"PRINCIPAL_ACCOUNT"`

        - `"PRINCIPAL_USER"`

        - `"PRINCIPAL_RUNNER"`

        - `"PRINCIPAL_ENVIRONMENT"`

        - `"PRINCIPAL_SERVICE_ACCOUNT"`

        - `"PRINCIPAL_RUNNER_MANAGER"`

    - `description: Optional[str]`

      description is a description of what the prompt does

    - `name: Optional[str]`

      name is the human readable name of the prompt

    - `organization_id: Optional[str]`

      organization_id is the ID of the organization that contains the prompt

    - `updated_at: Optional[datetime]`

      A Timestamp represents a point in time independent of any time zone or local
      calendar, encoded as a count of seconds and fractions of seconds at
      nanosecond resolution. The count is relative to an epoch at UTC midnight on
      January 1, 1970, in the proleptic Gregorian calendar which extends the
      Gregorian calendar backwards to year one.

      All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
      second table is needed for interpretation, using a [24-hour linear
      smear](https://developers.google.com/time/smear).

      The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
      restricting to that range, we ensure that we can convert to and from [RFC
      3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.

      # Examples

      Example 1: Compute Timestamp from POSIX `time()`.

      Timestamp timestamp;
      timestamp.set_seconds(time(NULL));
      timestamp.set_nanos(0);

      Example 2: Compute Timestamp from POSIX `gettimeofday()`.

      struct timeval tv;
      gettimeofday(&tv, NULL);

      Timestamp timestamp;
      timestamp.set_seconds(tv.tv_sec);
      timestamp.set_nanos(tv.tv_usec * 1000);

      Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.

      FILETIME ft;
      GetSystemTimeAsFileTime(&ft);
      UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

      // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
      // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
      Timestamp timestamp;
      timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
      timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

      Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.

      long millis = System.currentTimeMillis();

      Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
      .setNanos((int) ((millis % 1000) * 1000000)).build();

      Example 5: Compute Timestamp from Java `Instant.now()`.

      Instant now = Instant.now();

      Timestamp timestamp =
      Timestamp.newBuilder().setSeconds(now.getEpochSecond())
      .setNanos(now.getNano()).build();

      Example 6: Compute Timestamp from current time in Python.

      timestamp = Timestamp()
      timestamp.GetCurrentTime()

      # JSON Mapping

      In JSON format, the Timestamp type is encoded as a string in the
      [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
      format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
      where {year} is always expressed using four digits while {month}, {day},
      {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
      seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
      are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
      is required. A proto3 JSON serializer should always use UTC (as indicated by
      "Z") when printing the Timestamp type and a proto3 JSON parser should be
      able to accept both UTC and other timezones (as indicated by an offset).

      For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
      01:30 UTC on January 15, 2017.

      In JavaScript, one can convert a Date object to this format using the
      standard
      [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
      method. In Python, a standard `datetime.datetime` object can be converted
      to this format using
      [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
      the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
      the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format.

  - `spec: Optional[PromptSpec]`

    - `command: Optional[str]`

      command is the unique command string within the organization

    - `is_command: Optional[bool]`

      is_command indicates if this prompt is a command

    - `is_skill: Optional[bool]`

      is_skill indicates if this prompt is a skill (workflow instructions for agents)

    - `is_template: Optional[bool]`

      is_template indicates if this prompt is a template

    - `prompt: Optional[str]`

      prompt is the content of the prompt

### Example

```python
import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.agents.list_prompts(
    pagination={
        "page_size": 10
    },
)
page = page.prompts[0]
print(page.id)
```

#### Response

```json
{
  "pagination": {
    "nextToken": "nextToken"
  },
  "prompts": [
    {
      "id": "id",
      "metadata": {
        "createdAt": "2019-12-27T18:11:19.117Z",
        "creator": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "principal": "PRINCIPAL_UNSPECIFIED"
        },
        "description": "description",
        "name": "name",
        "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "updatedAt": "2019-12-27T18:11:19.117Z"
      },
      "spec": {
        "command": "command",
        "isCommand": true,
        "isSkill": true,
        "isTemplate": true,
        "prompt": "prompt"
      }
    }
  ]
}
```