Skip to main content
GET
/
v1
/
integration
/
prompts
List prompts
curl --request GET \
  --url https://api.aivra.cloud/v1/integration/prompts \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "project_id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "description": "<string>",
    "latest_version_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

​
Propósito

Lista prompts de um projeto, com metadados e latest_version_id.

​
Parâmetros

  • project_id (query, string) obrigatório

​
Dados retornados

Array com id, project_id, key, name, description, latest_version_id, created_at.

​
Exemplo de requisição

curl -H "X-API-Key: ak_xxxxxxxxx" \
  "${BASE_URL}/v1/integration/prompts?project_id=proj_abc"

​
Exemplo de resposta

[
  {
    "id": "pr_1",
    "project_id": "proj_abc",
    "key": "welcome",
    "name": "Boas-vindas",
    "description": null,
    "latest_version_id": "ver_12",
    "created_at": "2025-11-27T12:00:00Z"
  }
]

​
Códigos de status

  • 200 Sucesso
  • 404 Projeto não encontrado ou não pertence ao workspace
  • 403 Projeto não autorizado pela API Key

​
Casos de uso

  • Carregar a lista de prompts para edição ou consumo

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
project_id
string
required

Response

200 - application/json

OK

​
id
string
required
​
project_id
string
required
​
key
string
required
​
name
string
required
​
description
string | null
​
latest_version_id
string | null
​
created_at
string<date-time> | null