List prompt snippet references - LaunchDarkly Documentation

GET

api

projects

{projectKey}

ai-configs

prompt-snippets

{snippetKey}

references

List prompt snippet references

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references', 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://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references")

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

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

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

{
  "resourceKey": "resourceKey",
  "_links": {
    "next": {
      "href": "href",
      "type": "type"
    },
    "last": {
      "href": "href",
      "type": "type"
    },
    "prev": {
      "href": "href",
      "type": "type"
    },
    "self": {
      "href": "href",
      "type": "type"
    },
    "first": {
      "href": "href",
      "type": "type"
    }
  },
  "totalCount": 6,
  "items": [
    {
      "aiConfigKey": "aiConfigKey",
      "variationId": "variationId",
      "variationName": "variationName",
      "resourceVersion": 0,
      "aiConfigName": "aiConfigName"
    },
    {
      "aiConfigKey": "aiConfigKey",
      "variationId": "variationId",
      "variationName": "variationName",
      "resourceVersion": 0,
      "aiConfigName": "aiConfigName"
    }
  ],
  "resourceType": "resourceType"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

Authorizations

Authorization

string

header

required

Path Parameters

projectKey

string

required

snippetKey

string

required

Query Parameters

limit

integer

The number of resources to return.

offset

integer

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Response

Prompt snippet references

resourceKey

string

required

The key of the prompt snippet.

resourceType

string

required

The type of the resource being referenced.

items

object[]

required

Show child attributes

totalCount

integer

required

The total number of references.

_links

object

Show child attributes

Example:

{
  "next": { "href": "href", "type": "type" },
  "last": { "href": "href", "type": "type" },
  "prev": { "href": "href", "type": "type" },
  "self": { "href": "href", "type": "type" },
  "first": { "href": "href", "type": "type" }
}

⌘I

List prompt snippet references

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references', 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://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/projects/{projectKey}/ai-configs/prompt-snippets/{snippetKey}/references")

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

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

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

{
  "resourceKey": "resourceKey",
  "_links": {
    "next": {
      "href": "href",
      "type": "type"
    },
    "last": {
      "href": "href",
      "type": "type"
    },
    "prev": {
      "href": "href",
      "type": "type"
    },
    "self": {
      "href": "href",
      "type": "type"
    },
    "first": {
      "href": "href",
      "type": "type"
    }
  },
  "totalCount": 6,
  "items": [
    {
      "aiConfigKey": "aiConfigKey",
      "variationId": "variationId",
      "variationName": "variationName",
      "resourceVersion": 0,
      "aiConfigName": "aiConfigName"
    },
    {
      "aiConfigKey": "aiConfigKey",
      "variationId": "variationId",
      "variationName": "variationName",
      "resourceVersion": 0,
      "aiConfigName": "aiConfigName"
    }
  ],
  "resourceType": "resourceType"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}

{
  "code": "code",
  "message": "message"
}