> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Get prompts

GET http://localhost:5173/api/v1/private/prompts

Get prompts

Reference: https://www.comet.com/docs/opik/reference/rest-api/prompts/get-prompts

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Query parameters

- `page` (integer, optional, default: 1)
- `size` (integer, optional, default: 10)
- `name` (string, optional) — Filter prompts by name (partial match, case insensitive)
- `project_id` (string, optional)
- `sorting` (string, optional)
- `filters` (string, optional)

## Response

### 200

OK

- `page` (integer, optional)
- `size` (integer, optional)
- `total` (long, optional)
- `content` (list of Prompt_Public, optional)
- `sortableBy` (list of string, optional)

## Types

### Prompt_Public

- `name` (string, required)
- `id` (string, optional)
- `project_id` (string, optional) — Project ID. Takes precedence over project_name when both are provided.
- `description` (string, optional)
- `template_structure` (enum, optional, default: text) — Template structure type: 'text' or 'chat'. Immutable after creation.
  - Allowed values: `text`, `chat`
- `tags` (list of string, optional)
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)
- `version_count` (long, optional)

## Examples

**Response**

```json
{
  "page": 1,
  "size": 1,
  "total": 1,
  "content": [
    {
      "name": "string",
      "id": "string",
      "project_id": "string",
      "description": "string",
      "template_structure": "text",
      "tags": [
        "string"
      ],
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": "string",
      "last_updated_at": "2024-01-15T09:30:00Z",
      "last_updated_by": "string",
      "version_count": 1
    }
  ],
  "sortableBy": [
    "string"
  ]
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/prompts"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/prompts';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "http://localhost:5173/api/v1/private/prompts"

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/prompts")

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

request = Net::HTTP::Get.new(url)

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:5173/api/v1/private/prompts")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/prompts');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/prompts");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/prompts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```