Skip to main content

ListResponse[PromptSummaryResponse]

Paginated response containing Prompt Summary Response records. The required field is items.

items object[]required

List of resource items

  • Array [
  • idId (string)required

    Server-assigned unique identifier

    nameName (string)required

    Resource name

    alias object

    URL-safe short handle

    anyOf
    string
    categoryCategory (string)required

    Resource type tag

    typeType (string)required

    Content/format discriminator

    Possible values: [markdown, text, xml, graph]

    collection_id object

    Parent collection ID

    anyOf
    string
    folder_id object

    Identifier of the containing folder.

    anyOf
    string
    tags object

    Classification labels

    anyOf
  • Array [
  • string
  • ]
  • description object

    Resource description

    anyOf
    string
    markingsstring[]

    Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

    Default value: []
    created_at object

    Creation timestamp (Unix ms)

    anyOf
    integer
    updated_at object

    Last update timestamp (Unix ms)

    anyOf
    integer
    owners object[]

    Users and groups that own the resource.

  • Array [
  • idId (string)required

    "user." | "group." | "public.all"

    typeType (string)required

    Possible values: [user, group, public]

    display_nameDisplay Name (string)required
    avatar_url object
    anyOf
    string
    avatar_config object
    anyOf
    object
    email object
    anyOf
    string<email>
  • ]
  • my_share_scope object

    How the current caller received access to the resource.

    anyOf
    string

    Possible values: [owner, grant, admin]

    is_builtinIs Builtin (boolean)

    Whether this is a platform-provided built-in

    Default value: false
    variables object[]
  • Array [
  • nameName (string)required
    description object
    anyOf
    string
    default object
    anyOf
    string
    requiredRequired (boolean)
    Default value: true
  • ]
  • long_context object
    anyOf
    filenameFilename (string)required
    content_type object
    anyOf
    string
    sizeSize (integer)required

    Possible values: >= 0

    source_object_idSource Object Id (string)required
    markdown_object_idMarkdown Object Id (string)required
    statusStatus (string)

    Possible values: [pending, running, completed, failed]

    Default value: pending
    run_id object
    anyOf
    string
    error object
    anyOf
    string
    itemItem (string)requireddeprecated
  • ]
  • next_cursor object

    Cursor for next page

    anyOf
    string
    has_moreHas More (boolean)

    Whether more pages exist

    Default value: false
    ListResponse[PromptSummaryResponse]
    {
    "items": [
    {
    "id": "string",
    "name": "string",
    "alias": "string",
    "category": "string",
    "type": "markdown",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "description": "string",
    "markings": [
    "string"
    ],
    "created_at": 0,
    "updated_at": 0,
    "owners": [
    {
    "id": "string",
    "type": "user",
    "display_name": "string",
    "avatar_url": "string",
    "avatar_config": {},
    "email": "user@example.com"
    }
    ],
    "my_share_scope": "owner",
    "is_builtin": false,
    "variables": [
    {
    "name": "string",
    "description": "string",
    "default": "string",
    "required": true
    }
    ],
    "long_context": {
    "filename": "string",
    "content_type": "string",
    "size": 0,
    "source_object_id": "string",
    "markdown_object_id": "string",
    "status": "pending",
    "run_id": "string",
    "error": "string"
    }
    }
    ],
    "next_cursor": "string",
    "has_more": false
    }