List Prompts

GET 
https://api.relari.ai/v2/projects/:projectid/prompts/

List Prompts

Request

Path Parameters

projectid Projectidrequired

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

id Id (string)required
name Name (string)required
timestamp Timestamp (string)required
dataset Dataset (string)required

experiment

object

anyOf

MOD1

string

task_description Task Description (string)required
metric Metric (string)required
status Status (string)required

Possible values: [PENDING, RUNNING, COMPLETED, FAILED]

• ]

Example (from schema)

[
  {
    "id": "string",
    "name": "string",
    "timestamp": "string",
    "dataset": "string",
    "experiment": "string",
    "task_description": "string",
    "metric": "string",
    "status": "PENDING"
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://api.relari.ai/v2/projects/:projectid/prompts/' \
-H 'Accept: application/json' \
-H 'X-API-Key: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.relari.ai

Auth

APIKeyHeader

Parameters

projectid — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!