Skip to main content
GET
/
v1
/
prompts
/
{id}
Get a Prompt
curl --request GET \
  --url http://localhost:3000/v1/prompts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "prompt": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "name": "<string>",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": 123,
    "template": "Hello {{.name}}!",
    "created_at": "2023-11-07T05:31:56Z",
    "published_at": "2023-11-07T05:31:56Z",
    "tags": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Use an access token retrieved from login (Bearer sess_...) or a programmatic API key (Bearer ak_...).

Path Parameters

​
id
string
required

The unique UUID or unique slug of the prompt.

Query Parameters

​
version
string

Optional version sequence number (integer) or version tag (string) to retrieve along with the prompt details.

​
tag
string

Optional version tag (string) to retrieve along with the prompt details.

Response

Prompt details

​
prompt
object
required
​
version
object