List prompts

Python

import os

from profound import Profound

client = Profound(
    api_key=os.environ.get("PROFOUND_API_KEY"),
)

category = client.organizations.categories.prompts(
    category_id="7c9e6679-7425-40de-944b-e07fc1f90ae7",
    limit=10000,
    order_by="created_at",
    order_dir="desc",
    status=["active"],
)

print(category)

import Profound from '@profoundai/client';

const client = new Profound({
  apiKey: process.env['PROFOUND_API_KEY'], // defaults to the PROFOUND_API_KEY env var
  environment: 'production',
});

const category = await client.organizations.categories.prompts('7c9e6679-7425-40de-944b-e07fc1f90ae7', {
  limit: 10000,
  order_by: 'created_at',
  order_dir: 'desc',
  status: ['active'],
});

console.log(category);

use profound::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = ProfoundClient::builder()
        .api_key(std::env::var("PROFOUND_API_KEY")?)
        .build()?;

    let response = client
        .organizations()
        .categories()
        .prompts("7c9e6679-7425-40de-944b-e07fc1f90ae7")
        .send()
        .await?;

    println!("{:?}", response);

    Ok(())
}

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.tryprofound.com/v1/org/categories/{category_id}/prompts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryprofound.com/v1/org/categories/{category_id}/prompts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tryprofound.com/v1/org/categories/{category_id}/prompts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.tryprofound.com/v1/org/categories/{category_id}/prompts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "info": {
    "total_rows": 123,
    "limit": 123,
    "next_cursor": "<string>"
  },
  "data": [
    {
      "id": "<string>",
      "prompt": "<string>",
      "language": "<string>",
      "status": "active",
      "topic": {
        "id": "<string>",
        "name": "<string>"
      },
      "regions": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "platforms": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "analysis_types": [],
      "prompt_type": "",
      "tags": [],
      "personas": []
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

org

categories

{category_id}

prompts

Python

import os

from profound import Profound

client = Profound(
    api_key=os.environ.get("PROFOUND_API_KEY"),
)

category = client.organizations.categories.prompts(
    category_id="7c9e6679-7425-40de-944b-e07fc1f90ae7",
    limit=10000,
    order_by="created_at",
    order_dir="desc",
    status=["active"],
)

print(category)

import Profound from '@profoundai/client';

const client = new Profound({
  apiKey: process.env['PROFOUND_API_KEY'], // defaults to the PROFOUND_API_KEY env var
  environment: 'production',
});

const category = await client.organizations.categories.prompts('7c9e6679-7425-40de-944b-e07fc1f90ae7', {
  limit: 10000,
  order_by: 'created_at',
  order_dir: 'desc',
  status: ['active'],
});

console.log(category);

use profound::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = ProfoundClient::builder()
        .api_key(std::env::var("PROFOUND_API_KEY")?)
        .build()?;

    let response = client
        .organizations()
        .categories()
        .prompts("7c9e6679-7425-40de-944b-e07fc1f90ae7")
        .send()
        .await?;

    println!("{:?}", response);

    Ok(())
}

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.tryprofound.com/v1/org/categories/{category_id}/prompts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryprofound.com/v1/org/categories/{category_id}/prompts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tryprofound.com/v1/org/categories/{category_id}/prompts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.tryprofound.com/v1/org/categories/{category_id}/prompts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "info": {
    "total_rows": 123,
    "limit": 123,
    "next_cursor": "<string>"
  },
  "data": [
    {
      "id": "<string>",
      "prompt": "<string>",
      "language": "<string>",
      "status": "active",
      "topic": {
        "id": "<string>",
        "name": "<string>"
      },
      "regions": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "platforms": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "analysis_types": [],
      "prompt_type": "",
      "tags": [],
      "personas": []
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

category_id

string<uuid>

required

Query Parameters

limit

integer

default:10000

Maximum number of prompts to return.

Required range: x <= 10000

cursor

string | null

Pagination cursor from a previous response.

order_by

enum<string>

default:created_at

Field used to order prompts.

Available options:

created_at,

prompt

order_dir

enum<string>

default:desc

Sort direction for the selected order field.

Available options:

asc,

desc

analysis_type

enum<string>[]

Filter by analysis type (visibility, sentiment, accuracy).

Available options:

visibility,

sentiment,

sentiment_v2,

accuracy

prompt_type

enum<string>[]

deprecated

Deprecated. Use analysis_type instead.

Available options:

visibility,

sentiment

status

enum<string>[]

Filter by prompt status. Defaults to active only.

Available options:

active,

disabled

topic_id

string<uuid>[]

Filter by topic IDs.

tag_id

string<uuid>[]

Filter by tag IDs.

region_id

string<uuid>[]

Filter by region IDs.

platform_id

string<uuid>[]

Filter by platform IDs.

persona_id

string<uuid>[]

Filter by persona IDs.

Response

Successful Response

info

PaginationInfo · object

required

Show child attributes

data

Prompt · object[]

required

Show child attributes

Overview

SDKs

Integrations

Agents

Organization

Categories

Prompts

Knowledge Bases

OpenAI Ads

Answers

Reports

Content Optimization

Authorizations

Path Parameters

Query Parameters

Response